Skip to navigation
End UsersBulk DeletionEndpoints

Submit a bulk end-user deletion request

Submits a request to erase all personal data associated with the supplied identifiers. Replace example with your AI Agent’s handle. A successful call returns a 202 with a job_id you can poll for status. Requests that set client_reference are idempotent for 24 hours: an identical resubmission within that window returns the original job instead of creating a new one. Requests that omit client_reference are not deduplicated. Separately, the erasure engine rejects an identifier submitted within the previous 7 days, and a single identifier in that cooldown can fail an entire job.

Request

This endpoint expects an object.
identifierslist of objectsRequired
The identifiers to erase. At least one is required, and a single request accepts at most 1000.
client_referencestring or nullOptional

Optional caller-supplied reference echoed back on the job. It is also the idempotency key: two identical requests that set the same reference within 24 hours resolve to the same job. Requests that omit it are not deduplicated.

Response

The deletion request was accepted and a job was created.
job_idstringOptional
Identifier of the created deletion job. Use it to poll job status.
statusenumOptional

Lifecycle state of a deletion job. queued and in_progress are non-terminal; completed, partial, and failed are terminal.

Allowed values:
submitted_countintegerOptional
Number of identifiers received in the request.
created_atstringOptionalformat: "date-time"
Time the job was created, in ISO 8601 format.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error