Sign in

v1

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

Add Consent Groups to Parent Consent Group

Use this API to add Consent Groups as children of the specified Parent Consent Group.

🗒 Things to Know

  • A Consent Group can only be added as a child to one Parent Consent Group.
  • A Parent Consent Group can either have Consent Groups as children or data subjects as children within a given level in the hierarchy, not both. If Consent Groups are added as children to the Parent Consent Group, data subjects cannot be added to the Parent Consent Group at that given level.
  • Consent Groups can support a hierarchical structure of up to 4 levels. However, once data subjects are added as children to a Parent Consent Group, no additional Consent Groups can be added to that hierarchical structure.
post/api/consent/v2/consent-groups/{consentGroupGuid}/consent-groups

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.

Request body

consentGroupIdsstring[]

A list of Consent Groups to be added to a Consent Group as its children, identified by their ids

Example request

{
  "consentGroupIds": [
    "3b3ecf8f-afe5-4ff3-a621-5c519a385fae",
    "fa3ecf8f-afe5-41f3-a621-5c519a38521e"
  ]
}

Response

Consent Groups 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"
    }
  ]
}