Update preference

put

https://{region}-api.dotdigital.com/v2/preferences/{id}

Updates a preference or preference category by id

📘
How to find preference IDs
To find the id's for your existing preferences please call Get preferences

Path Params

string

required

Body Params

int32

required

The id of the preference or preference category that you want to update

publicName

string

required

The public name of the preference or the preference category. Contacts can see the public names of preferences in preference centres and signup forms.

privateName

string

required

The private name of the preference or the preference category. Contacts can't see private names in the preference centre or in signup forms.

isPreference

boolean

Defaults to false

If this value is true, a new preference is created. If this value is false, a new preference category is created.

order

string

The position that you want the preference or the preference category to appear on the 'Contact preferences' page, starting from 0. Specify either an integer for absolute position, alternatively use "top" or "bottom"

isPublic

boolean

Defaults to true

For preferences, if this value is true, the preference is visible in signup forms and preference centres.

categoryID

int32

For preferences, the unique ID of the preference category that you want to add the preference to. Default for preferences: 0. Default for preference categories: null

Headers

x-ddg-integration-token

string

/^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

Response

How to find preference IDs

200200