Docs
API 1.39
Status
Organisation

Purge the organisation's data within 24 hours

POST /v1/org/data-deletion: Purge the organisation's data within 24 hours

POST /v1/org/data-deletion
Operation idrequestDataDeletion
Key scopeadmin: admin keys only
SectionOrganisation

#Request body

FieldTypeRequiredDescription
confirmstringyesmin length 1

#Example request

curl -X POST "https://api.kaab.ist/v1/org/data-deletion" \
  -H "Authorization: Bearer $KAAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirm":"acme"}'

#Responses

#202

Scheduled

FieldTypeRequiredDescription
idstringyespattern ^exp_[0-9a-hjkmnp-tv-z]{26}$
scheduled_forstring (date-time)yes

#Errors

Every error answers with the error envelope; its code is one of the error codes.

StatusWhen
400request_invalid: request validation failed
401Missing or invalid API key
402insufficient_credits: top up to continue
403The key's scope does not cover this operation
409Conflicting state (see error.code)
422Semantically invalid request (see error.code)
429Rate limited; see Retry-After
500internal: unexpected server error

Was this page helpful?