Soft delete an entity (archives for audit trail)

Soft-delete (tombstone) an entity. Required scope: admin

DELETE /api/v1/entities/{id}/soft

cURL

curl --request DELETE \
  --url 'https://api.nsr.stateset.com/api/v1/entities/{id}/soft' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "Two-person tent, green — replacement for damaged pole set."
}'

Soft-delete (tombstone) an entity.

Required scope: admin

Path parameters

id · string · required

Entity ID

Request body

SoftDeleteRequest

reason · string

Reason for deletion (for audit trail)

Response

No response body. Entity soft deleted.

Status codes

Code	Meaning
200	Entity soft deleted
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
404	Entity not found
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request DELETE \
  --url 'https://api.nsr.stateset.com/api/v1/entities/{id}/soft' \
  --header "X-API-Key: $STATESET_NSR_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "Two-person tent, green — replacement for damaged pole set."
}'