Skip to main content
PATCH
Set a worker seat's monthly budget
Sets or clears (null) the monthly budget, in cents, of an EMPLOYEE or CONTRACTOR seat, and returns the seat as Get person shows it. The change is recorded on the person’s history. Requires org:manage and workforce:read at the platform scope, and the credential’s scopes must include workforce:read as well as org:manage (otherwise 403 naming workforce:read, and nothing changes). An agent seat, a seat without a person, or a seat of a person with any seat in a customer organization or under one returns 404, exactly as an unknown seat. Send an Idempotency-Key to make a retry safe: a same-key retry within 24 hours returns the recorded result only while those rules still hold; otherwise 409 idempotency_result_unavailable.

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

workerId
string
required

A human (EMPLOYEE or CONTRACTOR) worker seat's ID.

Minimum string length: 1

Body

application/json
budgetMonthlyCents
integer | null
required

The seat's monthly budget in cents; null clears it.

Required range: 0 <= x <= 9007199254740991

Response

Success

data
object
required
meta
object
required