ReferenceConsent
Replace the entire consent configuration
Replaces the configuration in full: every existing purpose, application and cookie is removed and replaced with the payload contents. Useful for copying consent setup between sites.
AuthorizationBearer <token>
Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.
In: header
X-Nimbu-Site<token>
Identifier of the site context when authenticating with a personal access token.
In: header
Header Parameters
X-Nimbu-Site*string
Site identifier
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "https://example.com/settings/consent" \ -H "X-Nimbu-Site: string" \ -H "Content-Type: application/json" \ -d '{}'{
"privacy_policy_kind": "string",
"privacy_policy_url": {},
"privacy_policy_page_id": "string",
"purposes": [
{
"name": "string",
"description": {}
}
],
"applications": [
{
"name": "string",
"title": {},
"description": {},
"purposes": [
"string"
],
"required": true,
"default": true,
"opt_out": true,
"placeholder_message": {},
"placeholder_action": {},
"cookies": [
{}
]
}
],
"cookies": [
{
"id": "string",
"name": "string",
"path": "string",
"domain": "string",
"application": "string"
}
]
}{
"message": "string",
"errors": {
"property1": [
"string"
],
"property2": [
"string"
]
}
}