Privacy Dashboard

Update privacy dashboard button labels

PUT/v4/config/platform/privacy-dashboard/button-labels

Changes the labels of the buttons of the privacy dashboard. An empty label sets the default label. The privacy dashboard and the public organisation details (Read organisation of the consent API for individuals) show the new label.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/platform/privacy-dashboard/button-labels' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "buttonLabels": {
    "dataUsingServicesButtonLabel": "Partners"
  }
}'

{
  "hostname": "acme-privacy.igrant.io",
  "version": "v2026.10.1",
  "status": 2,
  "statusStr": "Deployed",
  "buttonLabels": {
    "dataUsingServicesButtonLabel": "Partners"
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:privacy-dashboard:update

Body

application/json

buttonLabelsobject
The new labels. A label that you do not send becomes empty (the default label).

Response

application/json

The privacy dashboard record with the new labels.

hostnamestring
Host name of the privacy dashboard, for example acme-privacy.igrant.io. Empty when not deployed.
Example:"acme-privacy.igrant.io"
versionstring
Release of the privacy dashboard (a version of List privacy dashboard releases). Empty when not deployed.
Example:"v2026.10.1"
statusenum<integer>
Status of the deployment: 0 not configured, 1 requested (a deployment started and did not complete), 2 deployed.
Available options:0,1,2
Example:2
statusStrenum<string>
Label of status.
Available options:Not Configured,Requested,Deployed
Example:"Deployed"
buttonLabelsobject
The labels of the buttons of the privacy dashboard.