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.

NameTypeDescription
targetListobjectObject used to identify list. Can include ListType and ListKey objects.
targetList.ListTypeobjectObject that includes list type information. Can include listTypeID or ListTypeKey. The only valid value for ListTypeID is 3, indicating a data extension.
targetList.listKeystringID used to identify the list.
deleteListWhenCompletedbooleanIndicates 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.
deleteListContentsWhenCompletedbooleanIndicates 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.
StatusNameTypeDescription
200  Restrict request response
 operationInitiatedbooleanSystem-initiated restrict operation.
 operationIDintegerAuto-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.
 requestServiceMessageIDguidService message ID for the request.
 responseDateTimeintegerThe datetime restrict response is created in the system in GMT time.
 hasErrorsbooleanThe requested operation is initiated with an error or not.
 resultMessagesarrayArray of messages about the restrict operation.
 serviceMessageIDguidService message ID for the response.
    
400  Bad restrict request response
 operationInitiatedbooleanSystem-initiated restrict operation.
 operationIDintegerAuto-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.
 requestServiceMessageIDguidService message ID for the request.
 responseDateTimeintegerThe datetime restrict response is created in the system in GMT time.
 hasErrorsbooleanThe requested operation is initiated with error or not. For a 400 response this is true.
 resultMessagesarrayArray of messages about the restrict operation, with details about the bad request, like resulttype and resultcode.
 serviceMessageIDguidService message ID for the response.