Forget a person

POST

/audience/management/v1/individuals/{id}/forget

const url = 'https://api.ebitex.io/audience/management/v1/individuals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/forget';
const options = {method: 'POST', 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 POST \
  --url https://api.ebitex.io/audience/management/v1/individuals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/forget \
  --header 'Authorization: Bearer <token>'

Erases a person and the personal data held about them across the suite: their identities, linked browsers, interactions and permissions here, and the form submissions from those browsers and identities. It cannot be undone.

The run is fail-closed: browsers are revoked first, then each part of the suite erases in order, and the first failure stops the run, leaves the person in place and answers 500 so the call can be retried. A receipt with no personal data is kept.

Key: an Audience management key with audience.management.erase (write also needs read; erase needs both).

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Responses

200

{ "erasureId", "participants": [ { "key", "counts": { … } } ] }.

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired, or it was not created from the Audience settings page.

402

payment_required: the organization’s subscription needs attention.

403

scope_denied: the key lacks this route’s scope. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Audience is not enabled for the organization.

404

individual_not_found: no such person in this organization.

not_found: no such route.

429

rate_limited: the key spent its requests-per-minute budget; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.

500

<app>_erasure_failed: that part of the suite could not erase; nothing later ran and the person was kept. Retry.