Update Priority Scores for Purpose Statuses

Use this API to update the current Priority Score values for the Purpose Statuses. Priority Scores across the entire Consent Group hierarchy are used to calculate the Effective Status of a Purpose.

🗒

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. Any new Purpose Statuses will automatically be given a higher priority score by default.
  • When calculating the Effective Status of any Purpose in a Consent Group:
  • If there is no Parent Consent Group, the Effective Status becomes the same as the Enforced Status.
  • If there is a Parent Consent Group, the Effective Status would be calculated by comparing the Priority Score of the Enforced Status of the Purpose at that hierarchy level with the Priority Score of the Effective Status of the Purpose in the Parent level and applying the status associated with the lower Priority Score.
👍

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

Body Params
statusPriorityRules
array of objects
required

The Priority of the Purpose Statuses in the context of Consent Groups

statusPriorityRules*
Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*