Create Purpose

post

https://{hostname}/api/consentmanager/v1/purposes

Use this this API to create a new Purpose. The new Purpose will be created in Draft status and version 1.

🗒
Things to Know

This API returns Purpose descriptions inside <p> and </p> HTML tags. These can be sanitized depending on your formatting needs.

Query Params

isInternalOrg

boolean

Defaults to false

Specifies if the Purpose is for internal organization use

Body Params

Organizations

array of strings

A list of External Organization Ids.

Organizations

Name

string

required

Name of the Purpose

Description

string

required

Detailed description of the Purpose's intended use

ConsentLifeSpan

int64

required

The lifespan of consents recorded against this purpose in seconds

DefaultLanguage

string

The default language for the Purpose in BCP 47 format

Type

string

enum

Type of the Purpose

Allowed:

ParentPurposeId

uuid

Unique identifier of the parent purpose

attributeValues

object

Map of attribute values associated with the purpose

EnableGeolocation

boolean

Flag to enable geolocation tracking for this purpose

CustomPreferenceIds

array of uuids

List of custom preference IDs associated with the purpose

CustomPreferenceIds

ImplicitConsentLifeSpan

int64

Lifespan for implicit consents in seconds

ImplicitConsentConfirmDesc

string

Description shown when confirming implicit consent

HardOptOutDisplayFormat

string

enum

The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.

Allowed:

PurposeCategory

object

LastMajorVersion

int64

Version number of the last major update

VersionNotes

string

Release notes for the current version

IsMajorVersion

boolean

Indicates if this is a major version update

HardOptOutMessage

string

The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK - Successfully created purpose

400Bad Request

404Not Found

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