POST /contacts/v1/contacts/actions/restrict?type=ids
Restricts processing for contacts identified by ContactID values in the request. This operation runs asynchronously. Use the OperationID value returned to check the status of the delete.
Name | Type | | Description |
---|
Values | array | Required | Array of contact IDs to restrict. |
Status | Name | Type | Description |
---|
200 | | | Restrict request response |
| operationInitiated | boolean | System-initiated restrict operation. |
| operationID | integer | Auto-generated restrict operation ID. Keep track of this ID because it allows you to check the status of a restriction and decide how to proceed if there is a failure. |
| requestServiceMessageID | guid | Service message ID for the request. |
| responseDateTime | integer | The datetime restrict response is created in the system in GMT time. |
| hasErrors | boolean | The requested operation is initiated with an error or not. |
| resultMessages | array | Array of messages about the restrict operation. |
| serviceMessageID | guid | Service message ID for the response. |
| | | |
400 | | | Bad restrict request response |
| operationInitiated | boolean | System-initiated restrict operation. |
| operationID | integer | Auto-generated restrict operation ID. Keep track of this ID because it allows you to check the status of a restriction and decide how to proceed if there is a failure. |
| requestServiceMessageID | guid | Service message ID for the request. |
| responseDateTime | integer | The datetime restrict response is created in the system in GMT time. |
| hasErrors | boolean | The requested operation is initiated with error or not. For a 400 response this is true. |
| resultMessages | array | Array of messages about the restrict operation, with details about the bad request, like resulttype and resultcode. |
| serviceMessageID | guid | Service message ID for the response. |