Skip to main content
DELETE
Delete an end user
After a delete, the record no longer appears in list or get responses, and a second delete returns 404. Your audit log records the delete as enduser.deleted, with the API key as the source. Requires a key with the End-users permission. See API authentication.
string
required
The _id of the record, as returned by list or create.

Response

boolean
true on success.

Errors

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer YOUR_API_KEY. Campaign endpoints use campaign-scoped keys; the rest use organization or agent keys with the matching permission.

Path Parameters

endUserId
string
required

The end-user record ID

Response

End user soft-deleted with cascade

success
boolean
required

True when the record and its related data were soft-deleted.