Erase a contact

DELETE

/api/v1/contacts/{reference}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://dashboard.azimea.com/api/v1/contacts/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://dashboard.azimea.com/api/v1/contacts/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://dashboard.azimea.com/api/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.

Authorizations

ApiKey

Parameters

Path Parameters

reference

required

string

Responses

200

The erased contact’s id

application/json

object

isSuccess

boolean

value

One of:

object

object

string format: guid

status

integer format: int32

errors

Array<object>

object

code

string

message

string

params

object

key

additional properties

fieldErrors

object

key

additional properties

Array<object>

object

code

string

message

string

params

object

key

additional properties

Example

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

401

Missing or invalid API key

403

The key lacks the contacts:erase permission