GuidesSupport
DocumentationCookie ConsentMapsTag ManagerTranslation WidgetHeatmapsPlatformIngest

Consent Settings

Configure consent management rules. Create, list, update, and delete consent settings in your account.

GET
/rest/v1/consent-settings

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/consent-settings"
{
  "entities": [
    {
      "id": "string",
      "name": "string",
      "kind": "string",
      "status": "Disabled",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
POST
/rest/v1/consent-settings

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.oursprivacy.com/rest/v1/consent-settings"
{
  "isSuccess": true,
  "cause": "string",
  "consentSettings": {
    "id": "string",
    "name": "string",
    "kind": "string",
    "status": "Disabled",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/consent-settings/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/consent-settings/string"
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "Disabled",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
PATCH
/rest/v1/consent-settings/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Path Parameters

id*string

Request Body

application/json

categories*array<>
consentCookieName?|
customDomain?unknown
default?unknown
name*string
regions*array<>
revision?|
services*array<>
skipBlockingClassNames?array<>|
status*string
Value in"Disabled" | "Enabled"
webSDKToken?|
whitelistDomains?array<>|

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.oursprivacy.com/rest/v1/consent-settings/string" \  -H "Content-Type: application/json" \  -d '{    "categories": [      null    ],    "name": "string",    "regions": [      null    ],    "services": [      null    ],    "status": "Disabled"  }'
{
  "isSuccess": true,
  "cause": "string",
  "consentSettings": {
    "id": "string",
    "name": "string",
    "kind": "string",
    "status": "Disabled",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
DELETE
/rest/v1/consent-settings/{id}

Authorization

apiKey
AuthorizationBearer <token>

Clerk Organization API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.oursprivacy.com/rest/v1/consent-settings/string"
{
  "id": "string",
  "name": "string",
  "kind": "string",
  "status": "Disabled",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}

How is this guide?

Allowed Events

Previous Page

Global Dispatch Centers

Next Page