Skip to main content
Data requests

Request to update a data attribute of the individual

POST/v4/service/consent/organisation/consent-record/{consentRecordId}/data-agreement/{dataAgreementId}/data-attribute/{dataAttributeId}/data-update

Makes a request of the individual to update the data of one data attribute, under one of its consent records. The request has no body: the path names the consent record, its data agreement and the data attribute. The request starts in state 1 (initiated), and your organisation gets the webhook event data.update.initiated with the three IDs. Your organisation then handles the request and sets its state with Update data request. The request stores the e-mail address of the individual as userName.

The consent record must be a consent record of the individual, and dataAgreementId must be its data agreement. The server does not check dataAttributeId. The individual can have more than one open update request. The answer is 200 with an empty body. This route takes an API key or a token of the identity provider of the organisation, not an individual token or a token of the privacy dashboard login.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:data-requests:create

Path parameters

  • consentRecordIdstringrequired

    Consent record ID.

    Example:"6af081ea2d6fb7b6ac6efc71"

  • dataAgreementIdstringrequired

    Data agreement ID.

    Example:"6af080eb2d6fb7b6ac6efc57"

  • dataAttributeIdstringrequired

    Data attribute ID, from the dataAttributes of a data agreement.

    Example:"6af081a12d6fb7b6ac6efc6d"

Headers

  • X-ConsentBB-IndividualIdstring

    ID of the individual, or its externalId. Mandatory with an API key: without it the answer is 400 ("IndividualId is not present in request header"), and an unknown individual gets 400 too. With an individual token, leave it out: the server takes the individual from the token. Send it only on the routes that list it: with an API key that has resource scopes (for example consent-records:read), another route answers 400 to a request with this header.

    Example:"6af081b138e8f33dcf799628"

Response

The server saved the request. The body is empty.

No body.