Preference Centers
Get Preference Center Schema
Use this API to retrieve the schema of a Preference Center. The response will include details about the Preference Center such as settings, languages, and Purposes.
🗒 Things to Know
- This API can be used for Original, Enhanced, and Multi Page Preference Centers.
get/api/consentmanager/v1/preferencecenters/{prefcenterId}/preferences
Path parameters
prefcenterIdstring uuid required
Preference Center UUID
Query parameters
state'PUBLISHED' | 'DRAFT'
Draft or published preference center
Response
OK - Successfully retrieved Preference Center schema.
Example response
{
"PreferenceCentreId": "d3c9d247-8f0b-4277-bd22-01837d6db3e6",
"Purposes": [
{
"Id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
"Version": 2,
"Label": "Marketing Communications",
"Description": "Collect customer emails for marketing purposes",
"Status": "ACTIVE",
"PurposeType": "STANDARD",
"Languages": [
{
"Name": "Marketing Communications",
"Description": "Collect customer emails for marketing purposes",
"Description of Implicit Purpose Confirmation checkbox": "I can confirm",
"Language": "en-us",
"Default": true,
"HardOptOutMessage": "This purpose is required and cannot be opted out"
}
],
"Topics": [
{
"Id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
"Name": "Car Marketing",
"IntegrationKey": "Marketing-Communications_Car-Marketing",
"Languages": [
{
"Name": "Car Marketing",
"Language": "en-us",
"Default": true
}
]
}
],
"CustomPreferences": [
{
"Id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
"Name": "Email Frequency",
"Description": "Options for different frequencies to receive emails",
"Options": [
{
"Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
"Label": "Weekly",
"Order": 1,
"IsDefault": true
}
],
"Languages": [
{
"Name": "Monthly",
"Description": "Options for different frequencies to receive emails",
"Language": "en-us",
"Default": true,
"Options": [
{
"Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
"Label": "Weekly",
"Order": 1,
"IsDefault": true
}
]
}
]
}
],
"LifeSpan": 7889238,
"ImplicitConsentLifeSpan": 7889238,
"ImplicitConsentConfirmDesc": "I can confirm",
"DefaultConsentStatus": "OPT_OUT"
}
],
"Status": 200,
"Language": "en-us",
"Languages": [
"en-us",
"fr"
],
"Translations": {
"languageCode": {
"property": "value"
}
},
"DisplayNotificationPurpose": true,
"Template": "ENHANCED"
}