Data Attribute

Update data attribute

PUT/v4/config/consent/data-agreements/data-attribute/{dataAttributeId}

Changes the name, description, category or sensitivity of one data attribute, without a change of the rest of its data agreement. Send all four members: a member that you leave out becomes empty or false.

For a published data agreement the server raises the major version of the data agreement and saves a new revision. For a draft the version stays.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/consent/data-agreements/data-attribute/6af081a12d6fb7b6ac6efc6d' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "dataAttribute": {
    "name": "First name",
    "description": "First name to greet the reader in the newsletter",
    "category": "Contact",
    "sensitivity": false
  }
}'

{
  "dataAttribute": {
    "id": "6af081a12d6fb7b6ac6efc6d",
    "name": "First name",
    "description": "First name to greet the reader in the newsletter",
    "sensitivity": false,
    "category": "Contact",
    "restrictions": null
  }
}

Authorizations

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

Path parameters

dataAttributeIdstringrequired
Data attribute ID, from the dataAttributes of a data agreement.
Example:"6af081a12d6fb7b6ac6efc6d"

Body

application/json

dataAttributeobjectrequired
One item of personal data that a purpose uses, for example an email address.

Response

application/json

The updated data attribute.

dataAttributeobject
One item of personal data that a purpose uses, for example an email address.