Skip to main content
PATCH
Update position
Sets whether an agent may be assigned to a position (agentAssignable) and answers the WorkforcePosition. Requires org:manage and workforce:read at the platform scope. A missing position, one without an org unit, or one in or under a customer organization is 404. An active position whose org unit is inactive, or whose stored reporting chain is no longer valid (clear it with setPositionReporting), is 409. Instructions, role and assignment are not changed here.

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

positionId
string
required

The position to change.

Minimum string length: 1

Body

application/json
agentAssignable
boolean
required

Whether an agent may be assigned to the position.

Response

Success

data
object
required
meta
object
required