Skip to main content
POST
Offboard a person
Deactivates a person and revokes their identity claims, Personal keys, role grants and personal agents, ends live chat participations, deactivates their seats, and ends open pod memberships and confirmed staffing assignments where it can (the …Skipped counts are those it could not); effectiveAt is when the person left and reason (1–500 characters) is recorded in the audit. This is only partly reversible: Reactivate person restores the person and one seat, never claims, grants, keys or personal agents. 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). Without a key, a repeat returns 200 with alreadyInactive: true and changes nothing.

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.

Minimum string length: 1

Body

application/json
effectiveAt
integer
required

When the person left, epoch milliseconds (the Console sends now).

Required range: 0 <= x <= 9007199254740991
reason
string
required

Why the person is offboarded. 1–500 characters (trimmed); recorded in the audit.

Response

Success

data
object
required
meta
object
required