POST /contacts/v1/contacts/actions/delete?type=keys
Asynchronously deletes a contact when provided with its contact key. Use the OperationID
value returned to check the status of the deletion.
Name | Type | Description | |
---|---|---|---|
Values | array | Required | Array of contact key values to delete |
DeleteOperationType | string | Required | Type of delete operation to perform. Specify ContactAndAttributes to delete a contact and all its attributes from the entire account and channels. AttributesOnly is reserved for future use. |
This request deletes contacts specified by the contact key values passed in the values
array.
This asynchronous process places the deletion call in a queue for processing. The queue processes only one deletion call at a time, and each process can take several hours to complete.
This resource deletes contact information from the account, including the Email, MobileConnect, MobilePush, and GroupConnect apps, as well as lists, audiences, journeys, and Einstein analytics. This deletion occurs at the enterprise level.
A successful request suppresses any sends or other activities to the specified contacts for a specified number of days. The contact record still appears in Marketing Cloud Engagement, but you can’t include these suppressed contacts in any activities. After the specified number of days, the system deletes the contact from all lists and sendable data extensions. You can’t restore any contact information associated with this delete process. Any subscriberID number assigned to the contact can be recycled in the future. For Enterprise accounts, this process deletes all information at the Enterprise level.
To configure suppression number values, use the Configure Settings for Deleting Contacts resource.