Batch delete entities

Batch delete entities. Required scope: admin

DELETE /api/v1/entities/batch

cURL

curl --request DELETE \
  --url 'https://api.nsr.stateset.com/api/v1/entities/batch' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

200

{
  "deleted": 1,
  "not_found": 1
}

Batch delete entities.

Required scope: admin

Request body

BatchDeleteEntitiesRequest

ids · string[] · required

Response

BatchDeleteResponse

deleted · integer · required

not_found · 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

cURL

curl --request DELETE \
  --url 'https://api.nsr.stateset.com/api/v1/entities/batch' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

200

{
  "deleted": 1,
  "not_found": 1
}