v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Customers

BulkDeleteCustomers

Deletes multiple customer profiles.

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

post/v2/customers/bulk-delete

Request body

customer_idsstring[] required

The IDs of the customer profiles to delete.

Example request

{
  "customer_ids": [
    "8DDA5NZVBZFGAX0V3HPF81HHE0",
    "N18CPRVXR5214XPBBA6BZQWF3C",
    "2GYD7WNXF7BJZW1PMGNXZ3Y8M8"
  ]
}

Response

Success

responsesobject

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.

Example response

{
  "responses": {
    "2GYD7WNXF7BJZW1PMGNXZ3Y8M8": {
      "errors": [
        {
          "category": "INVALID_REQUEST_ERROR",
          "code": "NOT_FOUND",
          "detail": "Customer with ID `2GYD7WNXF7BJZW1PMGNXZ3Y8M8` not found."
        }
      ]
    },
    "8DDA5NZVBZFGAX0V3HPF81HHE0": {},
    "N18CPRVXR5214XPBBA6BZQWF3C": {}
  }
}