myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Create Purpose Preference

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

Use this API to create a new Purpose Preference. The Purpose Preference will be created with the details provided in the request body.

Body Params
string
required
length between 1 and 255

The display name of the Custom Preference. This will be shown to end users in the preference center.

string
required
length between 1 and 1000

Detailed description explaining the purpose and usage of this Custom Preference. This helps administrators understand the context of this preference.

string
enum
required

Defines how options can be selected in this Custom Preference. SINGLE_CHOICE allows only one option to be selected, while MULTI_CHOICE allows multiple selections.

Allowed:
string
enum
required

Specifies how the preference options should be displayed in the user interface. This affects the visual representation of the preference options.

Allowed:
boolean
Defaults to true

Indicates whether the provided language should be set as the default language for this Custom Preference. If true, the language specified in the 'language' field will be used as the default.

string
required
length β‰₯ 1

The language code for this Custom Preference in BCP 47 format. This specifies the language of the preference name, description, and options.

boolean
Defaults to false

Indicates whether a response is mandatory for this Custom Preference. If true, users must select an option before submitting the form.

boolean
Defaults to false

Indicates if this Custom Preference should be disabled. Disabled preferences are not shown to end users in the preference center.

Options
array of strings
required
length β‰₯ 1

List of available options for this Custom Preference. Each option should be a string representing a selectable choice.

Options*
Organizations
array of uuids

List of organization IDs that should have access to this Custom Preference. If empty, the preference will be available to all organizations.

Organizations
Purposes
array of uuids

List of Purpose IDs that this Custom Preference should be associated with. This links the preference to specific purposes in the system.

Purposes
Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 4 months ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 4 months ago