Update a person

Identity module

PATCH/people/{id}people.update

One human, linked to one sign-in. Personal facts are owned by the person. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability people.profile.write.
OAuth scopes: people.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

people.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the person.

Request body: PersonUpdate

people.update: PersonUpdate
Field	Type	Required	Description
full_name	string \| null	No	Legal or full name.Constraints: length 1 to 300
given_name	string \| null	No	Optional given name, as the person writes it.Constraints: length 1 to 100
family_name	string \| null	No	Optional family name, as the person writes it.Constraints: length 1 to 100

{
  "full_name": "Alex Rivera",
  "given_name": "Ivy",
  "family_name": "Marchetti"
}

Response 200: Person

people.update: Person
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the person.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
full_name	string \| null	Yes	Legal or full name.Constraints: length 1 to 300
given_name	string \| null	Yes	Optional given name, as the person writes it.Constraints: length 1 to 100
family_name	string \| null	Yes	Optional family name, as the person writes it.Constraints: length 1 to 100

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "full_name": "Alex Rivera",
  "given_name": "Ivy",
  "family_name": "Marchetti"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/people/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"full_name":"Alex Rivera","given_name":"Ivy","family_name":"Marchetti"}'

const { data, etag } = await xos.people.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "full_name": "Alex Rivera",
    "given_name": "Ivy",
    "family_name": "Marchetti"
  }, { ifMatch: etag });

response = xos.people.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"full_name": "Alex Rivera", "given_name": "Ivy", "family_name": "Marchetti"}, if_match=etag)

xos people update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"full_name":"Alex Rivera","given_name":"Ivy","family_name":"Marchetti"}' --if-match auto