Erase a user

Delete everything Tamr holds for one of your users: profile, sessions, conversations, ratings, orders and webhook deliveries.

DELETE/api/v1/sdk/users/{externalUserId}Server API · secret key

When one of your users asks to be forgotten, this deletes what Tamr holds for them: their profile, sessions, conversations, ratings, the orders you sent, unspent launch codes and the webhook deliveries that named them. An open chat finds its session gone on its next request. It's safe to call again: erased is false when there was nothing. It works even with the SDK switched off, so a restaurant can always honour an erasure. URL-encode the id if it has special characters.

Authentication

Server API. Send a secret API key with the Diner sessions (SDK) permission (diner:sdk) as Authorization: Bearer <key>. Secret keys are made in Settings > API keys by an owner or admin. Keep them on your server: no browser can call this route.

Path parameters

NameTypeRequiredDescription
externalUserIdstringYes1 to 200 characters.

Response

FieldTypeDescription
erasedboolean

Example

curl -X DELETE https://tamr.link/api/v1/sdk/users/user-88213 \
  -H "Authorization: Bearer $TAMR_SECRET_KEY"

Example response

{
  "erased": true
}

Errors

Every error has the same body; switch on data.code. See Errors and rate limits.

data.codeStatusWhat to do
other401No secret key, or one Tamr doesn't accept: wrong, revoked, or made by someone who is no longer an owner or admin.
other403The key doesn't have the diner:sdk permission.
invalid_request400A field doesn't match the spec. The message says which.
rate_limited429Wait retryAfter seconds (also in the Retry-After header), then try again.