> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Batch delete entities

> Batch delete entities. **Required scope:** admin

Batch delete entities.

**Required scope:** `admin`

### Request body

`BatchDeleteEntitiesRequest`

<ParamField body="ids" type="string[]" required />

### Response

`BatchDeleteResponse`

<ResponseField name="deleted" type="integer" required />

<ResponseField name="not_found" type="integer" required />

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | Batch deletion completed                           |
| `400` | Batch size exceeds the configured maximum          |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request DELETE \
    --url 'https://api.nsr.stateset.com/api/v1/entities/batch' \
    --header 'X-API-Key: YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "ids": [
      "string"
    ]
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "deleted": 1,
    "not_found": 1
  }
  ```
</ResponseExample>