v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Purpose Preferences

Get Purpose Preference

Use this API to retrieve a single Purpose Preference by its unique identifier along with details such as the Purpose Preference name, languages, number of options, created date, and updated date.

get/api/consentmanager/v1/custompreferences/{custompreferenceId}

Path parameters

custompreferenceIdstring uuid required

The UUID of the Custom Preference to be retrieved

Query parameters

includeTranslationsboolean

Parameter to include all of the Custom Preference's translations (by default is set to false)

Response

OK - Purpose Preference retrieved successfully.

Idstring uuid required

Unique identifier for the Custom Preference

Namestring required

The display name of the Custom Preference

Descriptionstring

Detailed description explaining the purpose and usage of this Custom Preference

SelectionType'SINGLE_CHOICE' | 'MULTI_CHOICE' | 'SINGLE_CHOICE' | 'MULTI_CHOICE' required

Defines how options can be selected in this Custom Preference

Specifies how the preference options should be displayed in the UI

CreatedDatestring date-time

Timestamp when the Custom Preference was created

UpdatedDatestring date-time

Timestamp when the Custom Preference was last updated

NumberOfOptionsinteger

Total number of available options for this Custom Preference

Requiredboolean

Indicates whether a response is mandatory for this Custom Preference

NumberOfLanguagesinteger

Number of languages this Custom Preference has been translated into

DefaultLanguagestring

The default language code for this Custom Preference (BCP 47 format)

Disabledboolean

Indicates if this Custom Preference is currently disabled

Organizationsstring[]

List of Organization IDs that have access to this Custom Preference

TotalLinkedActivePurposesinteger

Count of active purposes that reference this Custom Preference

Example response

{
  "Id": "194e0d3b-0ba8-4bc7-b046-e3ae42b2bd25",
  "Name": "Email Frequency",
  "Description": "Options for different frequencies to receive emails",
  "SelectionType": "SINGLE_CHOICE",
  "DisplayAs": "BUTTONs",
  "CreatedDate": "2023-01-15T10:52:30.974Z",
  "UpdatedDate": "2023-01-15T10:55:30.974Z",
  "NumberOfOptions": 4,
  "NumberOfLanguages": 3,
  "DefaultLanguage": "en-us",
  "Options": [
    {
      "Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
      "Label": "Weekly",
      "Order": 1,
      "IsDefault": true,
      "CanDelete": true
    }
  ],
  "Languages": [
    {
      "Name": "Email Frequency",
      "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,
          "CanDelete": true
        }
      ]
    }
  ],
  "Organizations": [
    "712a1f61-a548-432f-afc4-5a383c28eeb2"
  ],
  "TotalLinkedActivePurposes": 5
}