Skip to content

Forget a device

POST
/audience/delivery/v1/visitors/forget
curl --request POST \
--url https://api.ebitex.io/audience/delivery/v1/visitors/forget \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "visitor": "example" }'

Call this when a visitor asks to be forgotten: from a link in your footer, a button on a privacy page, or your own consent tool. The token stops working for good, and what that device unlocked is ended: the link between the device and a person in Audience, a connected contact, and any emailed-link verification. Remove the token from your own storage afterwards.

Forgetting a device is not erasing a person. The person, and anything they submitted, are left alone; erasing them is a separate action in Audience.

visitor is the token the device holds. The answer never depends on the token. It is always 200 with the organization’s own forgetDone wording, whether the token was valid, already forgotten, expired or made up, so the route cannot be used to find out which tokens are real. Calling it again is harmless. The response is private, no-store.

Key: audience.delivery.read

Media typeapplication/json
One of:
null
Examplegenerated
{
"visitor": "example"
}

{ "message": "…" }, the organization’s forgetDone wording.

invalid_api_key: the key is missing, revoked, expired or not an Audience delivery key.

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

origin_denied or ip_denied: the key’s restriction does not admit this request. app_not_available.

scope_denied: the key lacks this route’s scope. origin_denied or ip_denied: a browser-safe key was used from an origin or address outside its restrictions. app_not_available: Content is not enabled for the organization.

The body is larger than 16 KiB.

rate_limited: the key’s per-minute budget is spent; Retry-After says when it resets.

Quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.