Skip to content
AzimeaDocs
Dashboard
DELETE
/contacts/{reference}
curl --request DELETE \
--url https://api.azimea.com/v1/contacts/example \
--header 'Authorization: Bearer <token>'

Erases a person at their request (GDPR right to erasure), the same way the dashboard does: their name, address, attributes, tags and consent history are removed, a single anonymous row remains so a later import does not bring them back, and the other parts of Azimea erase theirs (timeline, flow runs, messages, orders, reports). It cannot be undone. reference is the contact’s Azimea id, ext:<your id> or email:<address>; the last two find only contacts your system or an import created, a store’s customers are found by their Azimea id. A contact already erased is not found again (404): nothing is left to erase. Needs the contacts:erase permission, which no other permission includes.

reference
required
string

The erased contact’s id

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

object
id

The id of the contact that was erased.

string format: guid
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Example
{
"isSuccess": true,
"value": {
"id": "01a10900-0000-7000-8000-000000000101"
},
"status": 0,
"errors": [],
"fieldErrors": null
}

Missing or invalid API key

The key lacks the contacts:erase permission

Audience.contact_not_found: no contact matches the reference, or it was already erased

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

nullable
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Examplegenerated
{
"isSuccess": true,
"value": "example",
"status": 1,
"errors": [
{
"code": "example",
"message": "example",
"params": {
"additionalProperty": "example"
}
}
],
"fieldErrors": {
"additionalProperty": [
{
"code": "example",
"message": "example",
"params": {
"additionalProperty": "example"
}
}
]
}
}

Too many requests for this key