v1

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

Get Preference Center Page Schema

Use this API to retrieve the schema for a specific page within a Multi Page Preference Center. The response will include the structure of the specified page within the Preference Center, including the sections, Purposes, and Data Elements.

get/api/consentmanager/v2/preferencecenterpage/{preferencecenterpageid}/schema

Path parameters

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

Unique identifier of the Preference Center Page.

Query parameters

state'PUBLISHED' | 'DRAFT'
Example:PUBLISHED

The state of the Preference Center.

Response

OK - Successfully retrieved preference center page schema.

idstring uuid

The unique identifier of the Preference Center Page

orderinteger

Order of Preference Center Page

isHiddenboolean

Indicates if the Preference Center page header is hidden

navigationEnabledboolean

Indicates if the Preference Center page navigation is enabled

displaySubscribeSettingsboolean

Indicates if Subscribe settings should be displayed on the page

displayUnsubscribeAllboolean

Indicates if the 'Unsubscribe All' option should be displayed on the page

displaySubscribeAllboolean

Indicates if the 'Subscribe All' option should be displayed on the page