<- Customers API

Customers API

Bulk delete customers

POST

 /v2/customers/bulk-delete

Deletes multiple customer profiles.

The endpoint takes a list of customer IDs and returns a map of responses.

Permissions:CUSTOMERS_WRITE
Try in API Explorer
Link to section

Request body

Example code

Link to section

customer_ids

string [ ]

Required

Link to section

Response fields

Link to section

responses

A map of responses that correspond to individual delete requests, represented by key-value pairs.

Each key is the customer ID that was specified for a delete request and each value is the corresponding response. If the request succeeds, the value is an empty object ({ }). If the request fails, the value contains any errors that occurred during the request.

Link to section

errors

Any top-level errors that prevented the bulk operation from running.