Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Preference Centers V2

Get Preference Center Root Schema

Use this API to retrieve the root schema for a Multi Page Preference Center. The response will include the root structure of the Preference Center, including the settings, languages, and configured pages.

get/api/consentmanager/v2/preferencecenters/{preferencecenterid}/schema

Path parameters

preferencecenteridstring uuid required
Example:156129da-7441-498d-a0eb-a89da357d741

Unique identifier of the Preference Center.

Query parameters

state'PUBLISHED' | 'DRAFT'

The state of the Preference Center.

Response

OK - Successfully retrieved preference center root schema.

defaultLanguagestring

The default language of the preference center

preferenceCenterSettingsobject

A list of labels and their translations for the preference center

enableMultipleIdentitiesboolean

Boolean flag that denotes if Multi-Identity is enabled for the Preference center

hierarchicalAccessControlboolean

Indicates if hierarchical access control is enabled for this preference center

displayUnsubscribeAllboolean

Boolean flag that denotes if Unsubscribe-All section needs to be displayed for the Preference center

displaySubscribeAllboolean

Boolean flag that denotes if Subscribe-All section needs to be displayed for the Preference center

displayNotificationPurposeboolean

Boolean flag that denotes if Notification purpose needs to be displayed on the Preference center

displaySubscribeSettingsboolean

Boolean flag that denotes if Subscribe settings section needs to be displayed for the Preference center

displayPageLevelSubscribeSettingsboolean

Boolean flag that denotes if Subscribe settings section is allowed to be configured specific to each Preference center page

autoCheckTopicsboolean

Boolean flag that denotes if auto check topics feature is enabled for the Preference center

updateNotOptedOutToActiveStatusboolean

Boolean flag that denotes if 'update not opted-out' to 'active' status is enabled for the Preference center

Example response

{
  "pages": [
    {
      "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
      "order": 1,
      "languages": [
        {
          "name": "Comunicaciones de marketing",
          "description": "Recopilar correos electrónicos de clientes con fines de marketing",
          "implicitConsentConfirmDesc": "I can confirm",
          "content": "<p>bloque de texto</p>",
          "language": "es"
        }
      ]
    }
  ],
  "defaultLanguage": "en",
  "languages": [
    {
      "name": "Comunicaciones de marketing",
      "description": "Recopilar correos electrónicos de clientes con fines de marketing",
      "implicitConsentConfirmDesc": "I can confirm",
      "content": "<p>bloque de texto</p>",
      "language": "es"
    }
  ],
  "notificationPurpose": {
    "id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
    "order": 1,
    "languages": [
      {
        "name": "Comunicaciones de marketing",
        "description": "Recopilar correos electrónicos de clientes con fines de marketing",
        "implicitConsentConfirmDesc": "I can confirm",
        "content": "<p>bloque de texto</p>",
        "language": "es"
      }
    ],
    "label": "Marketing Communications",
    "description": "Collect customer emails for marketing purposes",
    "implicitConsentConfirmDesc": "I agree to receive marketing communications",
    "version": 2,
    "topics": [
      {
        "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
        "name": "Car Marketing",
        "languages": [
          {
            "name": "Comunicaciones de marketing",
            "description": "Recopilar correos electrónicos de clientes con fines de marketing",
            "implicitConsentConfirmDesc": "I can confirm",
            "content": "<p>bloque de texto</p>",
            "language": "es"
          }
        ]
      }
    ],
    "customPreferences": [
      {
        "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
        "name": "Email Frequency",
        "description": "Options for different frequencies to receive emails",
        "selectionType": "SINGLE_CHOICE",
        "displayAs": "BUTTONS",
        "languages": [
          {
            "name": "Comunicaciones de marketing",
            "description": "Recopilar correos electrónicos de clientes con fines de marketing",
            "implicitConsentConfirmDesc": "I can confirm",
            "content": "<p>bloque de texto</p>",
            "language": "es"
          }
        ],
        "customPreferenceOptions": [
          {
            "id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
            "label": "Weekly",
            "order": 1,
            "isDefault": true,
            "languages": [
              {
                "name": "Comunicaciones de marketing",
                "description": "Recopilar correos electrónicos de clientes con fines de marketing",
                "implicitConsentConfirmDesc": "I can confirm",
                "content": "<p>bloque de texto</p>",
                "language": "es"
              }
            ]
          }
        ]
      }
    ]
  }
}