Skip to main content
PATCH
Update a person
Changes a person’s name, email, displayName, timezone or userType from patch, records reason in the audit, and returns the person. null clears a nullable field. A merged-away personId changes the person it was merged into; the result’s redirectedFrom names the ID you sent. Clearing the email of a person who signs in with it returns 400 (AUTHENTICATION_EMAIL_REQUIRED); an email another person uses returns 409 (PERSON_EMAIL_CONFLICT); a type that disagrees with an active seat returns 409 (PERSON_SEAT_TYPE_CONFLICT). A person with any seat in a customer organization or an org unit under one returns 404, exactly as an unknown person, and so does an ID merged into such a person. The credential’s scopes must include workforce:read as well as workforce:manage, because the success returns the person; otherwise 403 naming workforce:read, and nothing changes. Requires workforce:manage at the platform scope; a key or app whose grant covers only some org units receives 403. Send an Idempotency-Key to make a retry safe: a same-key retry within 24 hours returns the recorded result only while your scopes still include workforce:read, you still hold workforce:manage at the platform scope, and every person the result names is still in reach; otherwise 409 idempotency_result_unavailable, and the change is never made twice (see Idempotency).

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

personId
string
required

The person's ID (a merged-away ID resolves to the person it was merged into).

Minimum string length: 1

Body

application/json
patch
object
required
reason
string
required

Why the person changes (recorded in the audit).

Minimum string length: 1

Response

Success

data
object
required
meta
object
required