Update Purpose Preference

Use this API to edit a specific Purpose Preference. The Purpose Preference will be updated with the details provided in the request body.

customPreferenceIdstring uuid required

Example:82bd54d4-433a-451e-8512-950da5f9c1c6

The unique identifier of the Purpose Preference to update.

Request body

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 request

{
  "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
}

Response

OK - Purpose Preference updated successfully.