Erase contact (GDPR)

POST/api/v1/contacts/{id}/erase

Permanently erases the contact's personal data. The address is suppressed so that it never receives mailings again.

Name, phone, custom fields, tags and survey responses are removed, and the contact leaves all lists. What remains is the address in the suppression list and an entry in the consent log about the erasure. Cannot be undone.

Requires the contacts:erase scope.

Scope

contacts:erase Erase contacts (GDPR) – the person behind the key must be editor or higher.

Path parameters

idstringrequired: The contact's ID.

Retrying a request

Feel free to send the Idempotency-Key header (e.g. a UUID). If the same request is sent again with the same key within 24 hours, the first response is returned, without anything being done twice. Batch and idempotency

Response

204 Erased.

Errors

401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: shared_contact insufficient_scope forbidden workspace_suspended
404: not_found
409: idempotency_in_progress
422: idempotency_key_reused
429: rate_limited
500: internal_error