Individual

Update individual by mapper ID

PUT/v4/service/platform/individual/mapper/{mapperId}

Changes the individual that has this mapperId, for example to save the push notification token of a new device. Send only the members that you want to change: the service changes a member only when you send it with a value of at least two characters. A changed name or email also changes the login account of the individual, and a first email creates one.

This route takes an API key, or a token of the identity provider of the organisation: with such a token the individual can change only its own record, and another mapper ID gets 403. An individual token and a token of the privacy dashboard login get 403.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/service/platform/individual/mapper/app-user-2002' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "individual": {
    "pushNotificationToken": "<push-notification-token>",
    "deviceType": "ios"
  }
}'

{
  "individual": {
    "id": "6af0821c38e8f33dcf79962e",
    "externalId": "customer-1002",
    "externalIdType": "customerNumber",
    "identityProviderId": "",
    "name": "Sam Doe",
    "iamId": "",
    "email": "",
    "phone": "",
    "pushNotificationToken": "<push-notification-token>",
    "deviceType": "ios",
    "mapperId": "app-user-2002"
  }
}

Authorizations

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

Path parameters

mapperIdstringrequired
Mapper ID of the individual (mapperId).
Example:"app-user-2002"

Body

application/json

individualobjectrequired
A person whose consent the organisation records, for example a customer. The record can point to the person in another system through externalId. Keep personal data in it to the minimum that you need.

Response

application/json

The updated individual.

individualobject
A person whose consent the organisation records, for example a customer. The record can point to the person in another system through externalId. Keep personal data in it to the minimum that you need.