POST/v1/customers/{external_id}:erase

Erase a customer

Permanently erases the personal details of every customer record with this external ID, including deleted ones, and returns how many it erased. Also deletes their usage events, meters and holds; a repeat erases none. Needs customers:write.

curl -X POST 'https://api.entitler.co/v1/customers/ada:erase' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"}}'

Credentials

Send any one of these:

Bearer token

Path parameters

Name	Type	Description
`external_id`required	string

Request body

object

targetProductTarget
- environmentIdstring
- projectIdstring
- teamIdstring

Responses

`200`The EraseCustomerResponse message.

EraseCustomerResponse

erasedinteger (int64)required
at least 0; at most 4294967295

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired