Persons

Update a person

Updates the identity key value on the specified person profile. Returns 403 person_not_found if the person does not exist or is not accessible.

put/v5/persons/{person_id}

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v5/persons/:person_id/put.ts
A function with typed inputs. Its response is checked against the schema.

person_idstring required

Id for person to be updated

identity_key_valuestring

Value of the primary identity key for the person. Omit to leave the current value unchanged.

Updated person profile.

idstring required

Extole-assigned unique identifier for this person.

identity_idstring required

Identifier within the identity store that represents this person's merged profile.

identity_key_valuestring required

Value of the identity key for this person.

versionstring required

Optimistic-concurrency version token for the person record.

No recorded changes to this operation across all 1 revision of this API.