Update a user

PATCH/v1/directory/people/{person_id}

Changes someone's name or email address. Send only what changes.

Permission: identity:UpdateUser. Changes need a sign-in that used a second factor.

Path parameters

Parameter Type Description
person_id string The person's ID.

Body

Field Type Description
given_name string Their first name.
family_name string Their last name.
email string Their email address.

Returns

200 OK

{
  "person": {
    "id": "8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10",
    "email": "pat@example.com",
    "username": "patlee",
    "name": "Pat Lee-Park",
    "given_name": "Pat",
    "family_name": "Lee-Park",
    "status": "invited",
    "email_verified": false,
    "last_sign_in_at": null,
    "mfa_devices": 0,
    "profile_managed": false,
    "created_at": "2026-11-19T09:00:00Z",
    "updated_at": "2026-11-19T09:00:00Z"
  }
}

Errors

Besides the errors every call can return:

Status When
400 A malformed name or email.
404 No such resource in your organization.
409 That address already has an account.

Example

curl -X PATCH https://<company>.yotta.bot/v1/directory/people/8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10 \
  -H "Authorization: Bearer $YOTTABOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"family_name": "Lee-Park"}'

With yottactl

yottactl org users update 8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10 \
  --set family_name=Lee-Park