Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Preference Centers

Withdraw Data Subject's Consent for All Purposes in a Preference Center

Use this API to withdraw a data subject's consent for all Purposes within a Preference Center.

🗒 Things to Know

  • The Notification Opt-Out Purpose will be excluded when calling this API.
delete/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences

Path parameters

prefcenterIdstring uuid required
Example:156129da-7441-498d-a0eb-a89da357d741

Preference Center UUID.

Query parameters

identifierstring
Example:user@example.com

Data Subject Identifier (prefer the header parameter).

Headers

identifierstring
Example:user@example.com

Data Subject Identifier (prefer the header parameter).

Response

OK - Successfully withdrew data subject's consent for all purposes.

Languagestring

The preferred language of the Data Subject in BCP 47 format

Example response

{
  "Purposes": [
    {
      "messages": [
        "added",
        "updated"
      ],
      "Id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "Status": true,
      "ReceiptGuid": "64a9b83e-3aae-4e9f-b75e-5fbd01aecd85"
    }
  ],
  "Language": "en-us"
}