BIbigchange
Persons

Set a person's data consent

Captures information about when a person granted/denied consent to have their personal data stored (required scope contacts:persons:write)

put/v1/persons/{personId}/dataConsent

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/persons/{personId}/dataConsent
  • Auth
    HTTP bearer

Path parameters

personIdstring uuid required

Person id

Headers

Customer-Idinteger required

The customer identifier

Request body

status'awaiting' | 'refused' | 'granted' required

The consent preference indicated by the person<p>Possible values:</p><ul><li><b>awaiting</b>: Awaiting</li><li><b>refused</b>: Refused</li><li><b>granted</b>: Granted</li></ul>

medium'email' | 'click' | 'telephone' required

The medium that a person has expressed their consent using<p>Possible values:</p><ul><li><b>email</b>: Email</li><li><b>click</b>: Click</li><li><b>telephone</b>: Telephone</li></ul>

commentstring nullable

Descriptive text about how and/or why the person has made this consent decision

Example request

{
  "status": "awaiting",
  "medium": "email",
  "comment": "Happy for their data to be held"
}

Response

No Content

Changes

No recorded changes to this operation across all 13 revisions of this API.