Add Purpose Rules to Consent Group

Use this API to add Purpose Rules to a Consent Group. These rules will dictate which Purposes will be overridden with the defined Enforced Status for data subjects within the given Consent Group.

πŸ—’

Things to Know

  • Each Purpose in a Consent Group has its own Purpose Rule which is comprised of an Enforced Status and Effective Status.
  • The Enforced Status is the Purpose Status that you want to apply for a particular Purpose.
  • The Effective Status is calculated using the Priority Scores across the entire Consent Group hierarchy for each Purpose.
Path Params
uuid
required

The UUID of the Consent Group. consentGroupGuid can be retrieved using the Get a paged view for consent groups API to add Purpose Rules

Body Params
purposeRules
array of objects
length between 1 and 2147483647

A list of Purpose Rules to be added to a Consent Group

purposeRules
uuid
required

Identifier identifying a Purpose

string
length β‰₯ 1

The Transaction Status enforced by the Consent Group for this Purpose

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

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
*/*