---
title: "Purge customers"
method: DELETE
path: "/api/merchant/v2/customers"
tags: ["Customers"]
---

# Purge customers

`DELETE /api/merchant/v2/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.

## Request body

- CustomerIdentifierCollectionInput — A collection of identifiers for customers in Mention Me.
  - `identifiers` CustomerIdentifierInterface[], required — Maximum of 100 identifiers.
    - union
      - CustomerEmailIdentifier
        - `type` 'email', required — The type of identifier.
        - `value` string
      - CustomerIdIdentifier
        - `type` 'customerId', required — The type of identifier.
        - `value` string, required

## Response `202`

All identifiers that were queued to be purged.

- BulkCustomerResponse — A collection of customer identifiers which were accepted, or resulted in an error.
  - `accepted` CustomerIdentifierInterface2[] — All the identifiers that were accepted.
    - union
      - CustomerEmailIdentifier2
        - `type` 'email', required — The type of identifier.
        - `value` string
      - CustomerIdIdentifier2
        - `type` 'customerId', required — The type of identifier.
        - `value` string, required
  - `errors` CustomerErrorPayloadInterface2[] — All the identifiers which resulted in errors.
    - `type` 'email' | 'customerId'
    - `value` string
    - `reason` 'notFound'

## Other responses

- `401` — Required scopes are missing.
- `404` — No customers matched the identifiers.
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/mention-me/apis/auth-api.md) · [All operations](https://skmtc.net/mention-me/apis/auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mention-me/auth-api/versions/cdad84f071bd/schema)