POST /contacts/v1/contacts/actions/restrict?type=listReference
Restricts processing for contacts identified by listReference values in the request. This operation runs asynchronously. Use the OperationID value returned to check the status of the delete.
Name | Type | | Description |
---|
targetList | object | | Object used to identify list. Can include ListType and ListKey objects. |
targetList.ListType | object | | Object that includes list type information. Can include listTypeID or ListTypeKey. The only valid value for ListTypeID is 3, indicating a data extension. |
targetList.listKey | string | | ID used to identify the list. |
deleteListWhenCompleted | boolean | | Indicates whether to delete the list after requesting it. This option does not apply to lists identified by ID, key, or reference. If this option is true, the process skips lists marked as not deletable, issues a warning, and continues processing remaining lists. |
deleteListContentsWhenCompleted | boolean | | Indicates whether to delete the contents of a list after requesting it. This option does not apply to lists identified by ID, key, or reference. If this option is true, the process skips lists marked as not deletable, issues a warning, and continues processing remaining lists. |
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. |