Update Purpose Preference

put

https://{hostname}/api/consentmanager/v1/custompreferences/{customPreferenceId}

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

Path Params

customPreferenceId

uuid

required

The unique identifier of the Purpose Preference to update.

Body Params

uuid

required

Unique identifier for the Custom Preference

Name

string

required

length between 1 and 255

The display name of the Custom Preference

Description

string

length ≤ 1000

Detailed description explaining the purpose and usage of this Custom Preference

SelectionType

string

enum

required

Defines how options can be selected in this Custom Preference

Allowed:

DisplayAs

string

enum

required

Specifies how the preference options should be displayed in the UI

Allowed:

CreatedDate

date-time

Timestamp when the Custom Preference was created

UpdatedDate

date-time

Timestamp when the Custom Preference was last updated

NumberOfOptions

int64

≥ 0

Total number of available options for this Custom Preference

Required

boolean

Defaults to false

Indicates whether a response is mandatory for this Custom Preference

NumberOfLanguages

int64

≥ 0

Number of languages this Custom Preference has been translated into

DefaultLanguage

string

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

Disabled

boolean

Defaults to false

Indicates if this Custom Preference is currently disabled

Options

array of objects

List of available options for this Custom Preference

Options

Languages

array of objects

List of language configurations for this Custom Preference

Languages

Organizations

array of uuids

List of Organization IDs that have access to this Custom Preference

Organizations

TotalLinkedActivePurposes

int64

≥ 0

Count of active purposes that reference this Custom Preference

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK - Purpose Preference updated successfully.

429Too Many Requests. For more information, see API Rate Limits.