Individual

Update individual by mapper ID

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

Changes the individual of the organisation that has this mapperId. It works as Update individual: send only the members that you want to change, because the service changes a member only when you send it with a value of at least two characters, so you cannot empty a member. A changed name or email also changes the login account of the individual, and a first email creates one.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/platform/individual/mapper/app-user-2001' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "individual": {
    "phone": "+46700000002"
  }
}'

{
  "individual": {
    "id": "6af081b138e8f33dcf799628",
    "externalId": "customer-1001",
    "externalIdType": "customerNumber",
    "identityProviderId": "",
    "name": "Alex Doe",
    "iamId": "3314e64f-b0ab-4078-923f-2250ebbbd9aa",
    "email": "[email protected]",
    "phone": "+46700000002",
    "pushNotificationToken": "",
    "deviceType": "android",
    "mapperId": "app-user-2001"
  }
}

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-2001"

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.