Delete contact
Deleting a contact in Engage is done through the /contacts endpoint using the contactId:
DELETE /api/v2/contacts/{contactId}
In the header, you can choose send the source parameter to show how the contact was deleted (it's not mandatory but is useful for tracking the deletion reasons).
Parameter | Type | Description |
|---|---|---|
source | string | An indication of how the contact was deleted. Example values are "POS" or "e-com" but you can send anything else you want. |
There is no payload sent with this request.
Caution
This endpoint is not to be used for batch deletion. For mass deletion of contacts, use the Engage UI or machine-to-machine bulk integrations methods (see this section).
Responses
A successful deletion will return HTTP 200 Ok.
You will get a HTTP 404 Not Found if the contact with that ID could not be found or was already deleted.