Skip to main content
POST
Reactivate a person
Raises an inactive employee or contractor and one worker seat, records reason (1–500 characters) in the audit, and returns the person with seatReactivated. Claims, role grants, Personal keys and personal agents stay revoked: give access again deliberately. A person who is not inactive, or not an employee or contractor, returns 409; a merged-away ID returns 404. 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 409 because the person is no longer inactive.

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
reason
string
required

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

Response

Success

data
object
required
meta
object
required