Skip to content

Retire a consent statement and retain evidence.

DELETE
/api/admin/consent-statements/{id}
Code sample: Shell / cURL
curl --request DELETE \
--url https://auth.example.com/api/admin/consent-statements/example \
--header 'Authorization: Bearer <token>'

Sets is_active=0 and retired_at, advances definition/closed generations and enqueues closed projection. Records, history, versions and bodies are retained. Replaces the former evidence cascade deletion. Physical deletion is limited to provably never-active drafts with zero record/history references across every account shard; unreadable shards abort deletion.

id
required
string

Consent statement identifier.

Retirement or removal of an unreferenced never-active draft.

Media type application/json
object
success
required
boolean
disposition
required
string
Allowed values: retired deleted
Example
{
"success": true,
"disposition": "retired"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}