v1

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

Get Priority Scores for Purpose Statuses

Use this API to retrieve the Priority Scores for each Purpose Status.

🗒 Things to Know

  • All Purpose Statuses are given a Priority Score. A Purpose Status with a lower Priority Score will be given precedence over a Purpose Status with a higher Priority Score.
  • 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.

👍

For more information, see Using Consent Groups to Alter a Data Subject's Consent Status.

get/api/consent/v2/consent-groups/settings

Response

Successfully retrieved Consent Group settings.

Example response

{
  "statusPriorityRules": [
    {
      "status": "ACTIVE",
      "priority": 3
    }
  ]
}