Block Contact
Path parameters
idstringRequired
The Contact ID.
Responses
200
OK
application/json
400
Bad Request
application/json
post
POST /public/v1/notifications/contacts/{id}/block HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2025-08-06T09:20:00.483Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-06T09:20:00.483Z",
"by": "[Circular Reference]"
},
"activated": {
"at": "2025-08-06T09:20:00.483Z",
"by": "[Circular Reference]"
},
"blocked": {
"at": "2025-08-06T09:20:00.483Z",
"by": "[Circular Reference]"
},
"deleted": {
"at": "2025-08-06T09:20:00.483Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"blockedReason": "text",
"email": "text",
"name": "text",
"optOuts": [
{
"id": "text",
"description": "text",
"name": "text",
"icon": "text",
"lastUsed": "2025-08-06T09:20:00.483Z"
}
],
"status": "text",
"userId": "text",
"user": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"invitationAcceptedAt": "2025-08-06T09:20:00.483Z"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-08-06T09:20:00.483Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
}
}
}
Last updated
Was this helpful?