Skip to content

Create a consent purpose

POST
/settings/consent/purposes

Authorizations

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Request Body

application/json
JSON
{
"name": "string",
"description": {
"additionalProperties": "string"
}
}

Responses

purpose created

application/json
JSON
{
"name": "string",
"description": {
}
}

Playground

Authorization
Body

Samples

Part of Nimbu, built by Zenjoy.