Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Consent Groups

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.
post/api/consent/v2/consent-groups/{consentGroupGuid}/purpose-rules

Path parameters

consentGroupGuidstring uuid required
Example:1a6c1e65-aa4f-4d79-ac62-7fe905616f71

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

Request body

Example request

{
  "purposeRules": [
    {
      "purposeId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "enforcedStatus": "ACTIVE"
    }
  ]
}

Response

Purpose Rules added successfully.

namestring

The Consent Group name

descriptionstring

A description of the Consent Group

externalNamestring

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

consentGroupIdstring uuid

Unique identifier identifying a Consent Group

membershipType'EMPTY' | 'CHILD_GROUPS' | 'DATA_SUBJECTS'

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

Example response

{
  "name": "OneTrust Atlanta",
  "description": "Consent for the company OneTrust, specifically for the Atlanta Office. Contains subsidiary data subjects representing OneTrust employees that work at this location.",
  "externalName": "onetrust_atlanta",
  "consentGroupId": "2a644966-fe93-4561-b71a-f0dda4396459",
  "membershipType": "CHILD_GROUPS",
  "purposeRules": [
    {
      "purposeId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "enforcedStatus": "ACTIVE",
      "effectiveStatus": "OPT_OUT"
    }
  ],
  "dataSubjects": [
    {
      "id": "633ba071-61b0-485f-81a0-a2245777b432",
      "identifier": "example@otprivacy.com",
      "purposes": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "version": 2,
          "status": "ACTIVE",
          "effectiveStatus": "OPT_OUT"
        }
      ]
    }
  ],
  "consentGroups": [
    {
      "name": "OneTrust Atlanta",
      "description": "Consent for the company OneTrust, specifically for the Atlanta Office. Contains subsidiary data subjects representing OneTrust employees that work at this location.",
      "externalName": "onetrust_atlanta",
      "consentGroupId": "2a644966-fe93-4561-b71a-f0dda4396459",
      "membershipType": "CHILD_GROUPS"
    }
  ]
}