Skip to content
Authrim

Activate a consent statement version.

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

Activates a draft consent statement version after validation, including required localization checks. The activated version is returned.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
sid
required
string

Consent statement identifier.

vid
required
string

Consent statement version identifier.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Consent statement version response.

Media type application/json
object
id
required
string
tenant_id
required
string
statement_id
required
string
version
required
string
/^[0-9]{8}$/
content_type
required
string
Allowed values: url inline
effective_at
required
integer format: int64
effective_until

Optional end timestamp. Null means no planned end.

integer | null format: int64
is_current
required
integer
Allowed values: 0 1
status
required
string
Allowed values: draft active retired
created_at
required
integer format: int64
updated_at
required
integer format: int64
key
additional properties
Example 
{
  "content_type": "url",
  "is_current": 0,
  "status": "draft"
}

400

Section titled “400 ”

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"
}

401

Section titled “401 ”

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"
}

403

Section titled “403 ”

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"
}

500

Section titled “500 ”

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"
}