Create Consent Group

Use this API to create a new Consent Group by providing a name, description, and optional external name.

🗒

Things to Know

  • If an external name is not defined, one will be generated automatically.
Body Params

consentGroupRequest

string

A description of the Consent Group

string

The Consent Group's external name. If not provided, this will be generated based on the name

string

The Consent Group name

Responses

Response body
object
uuid

Unique identifier identifying a Consent Group

consentGroups
array of objects

Consent Groups that are children of the current Consent Group

consentGroups
object
uuid

Unique identifier identifying a Consent Group

string

A description of the Consent Group

string

The Consent Group's external name. If not provided, this will be generated based on the name

string

Indicates whether the consent group has other consent groups as its children, or if it has data subjects associated to it

EMPTY CHILD_GROUPS DATA_SUBJECTS

string

The Consent Group name

dataSubjects
array of objects

The Consent Group's Data Subjects

dataSubjects
object
uuid

Unique Identifier identifying a Data Subject

string

The Data Subject identifier value

purposes
array of objects

The Data Subject's Purpose list

purposes
object
string

The Data Subject's effective status for this Purpose, in the context of the specified Consent Group

uuid

Identifier identifying a Purpose

string

The Data Subject's actual consent status for this Purpose

int64

The Purpose's version

string

A description of the Consent Group

string

The Consent Group's external name. If not provided, this will be generated based on the name

string

Indicates whether the consent group has other consent groups as its children, or if it has data subjects associated to it

EMPTY CHILD_GROUPS DATA_SUBJECTS

string

The Consent Group name

purposeRules
array of objects

The Consent Group's Purpose Rules

purposeRules
object
string

The Consent Group's effective Transaction Status for this Purpose, which is calculated based on the Consent Group hierarchy

string

The Transaction Status enforced by the Consent Group for this Purpose

uuid

Identifier identifying a Purpose

401

Unauthorized

403

Forbidden

404

Not Found

Language
Credentials
OAuth2