Sign in

v1

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

Update Data Subject's Preferences in a Preference Center

Use this API to update the data subject's preferences within a Preference Center.

🗒 Things to Know

  • Pascal case is required for all parameters. For example, use DsDataElements instead of dsDataElements.
put/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).

Request body

DsDataElementsobject

Map of Data Subject Elements and their values. Maximum supported characters for a data element value is 750.

Languagestring

The preferred language of the Data Subject in BCP 47 format

dsDataElementsobject

Example request

{
  "Purposes": [
    {
      "Id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
    }
  ],
  "DsDataElements": {
    "First Name": "John",
    "Last Name": "Doe"
  },
  "Language": "en-us"
}

Response

OK - Successfully updated data subject's preferences.

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"
}