Update Purpose

put

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

Path Params

purposeId

uuid

required

Query Params

isInternalOrg

boolean

Defaults to false

Body Params

Organizations

array of strings

Organizations

Name

string

required

Description

string

required

ConsentLifeSpan

int64

required

DefaultLanguage

string

Type

string

enum

Allowed:

ParentPurposeId

uuid

attributeValues

object

EnableGeolocation

boolean

CustomPreferenceIds

array of uuids

CustomPreferenceIds

ImplicitConsentLifeSpan

int64

ImplicitConsentConfirmDesc

string

HardOptOutDisplayFormat

string

enum

Allowed:

PurposeCategory

object

LastMajorVersion

int64

VersionNotes

string

IsMajorVersion

boolean

HardOptOutMessage

string

Status

string

enum

required

Allowed:

Languages

array of objects

Languages

TopicIds

array of uuids

TopicIds

Version

int64

required

≥ 1

ExpiryDateType

string

enum

Allowed:

Headers

accept

string

enum

Defaults to application/json

Allowed:

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*