Create preference

post

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

Creates a new preference or a new preference category

Path Params

region

string

enum

required

Defaults to r1

The Dotdigital region id your account belongs to e.g. r1, r2 or r3

Allowed:

Body Params

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

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200