Consent Settings

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

GET
/rest/v1/consent-settings
AuthorizationBearer <token>

Ours Privacy 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
AuthorizationBearer <token>

Ours Privacy 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": {}
}
{
  "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}
AuthorizationBearer <token>

Ours Privacy 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"
{}
{
  "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}
*object
array<object>
object
array<object>
array<object>
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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": [      {        "label": "string",        "priority": 0,        "value": "string"      }    ],    "default": {      "categories": [        {          "key": "string",          "value": {            "enabled": true          }        }      ],      "language": "string",      "mode": "opt_in",      "translations": [        {          "language": "string",          "value": {}        }      ]    },    "name": "string",    "regions": [      {        "regionCode": "string",        "rule": {          "categories": [            {              "key": "string",              "value": {                "enabled": true              }            }          ],          "language": "string",          "mode": "opt_in",          "translations": [            {              "language": "string",              "value": {}            }          ]        }      }    ],    "services": [      {        "internalNotes": "string",        "label": "string"      }    ],    "status": "Disabled"  }'
{
  "isSuccess": true,
  "cause": "string",
  "consentSettings": {}
}
{
  "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}
AuthorizationBearer <token>

Ours Privacy 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?