Purge customers

Purge all customers matching the given identifiers.

Purging is a permanent action. Once a customer is purged, they cannot be recovered.

Purging is done on a queue. It may take some time for the customers to be purged. We recommend using the GET /v2/customers endpoint to determine if the customers have been purged. Approximate time to purge is normally under < 5 minutes, but can be several hours in some cases.

Customers who we were able to queue will be returned in the accepted array. Customers who we do not hold a record of or cannot find will be returned in the errors array.

Scopes: customers:delete

Rate limits: 300 requests per 5 minutes. Shared across all 'customers' endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
identifiers
array of objects
required
length between 1 and 100

Maximum of 100 identifiers.

identifiers*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json