Skip to main content
POST
Preview pod membership
Previews one pod membership change exactly as the Console’s pod page does, and changes nothing. The body is { "operation": { "kind": ..., "args": { ... } } }, where kind is add, change-effective, update-future or end and args are the Console’s fields for that change; unknown fields are 400. A ready result echoes the operation as confirmation, names the pod and the worker (worker ID, name and type), and, when the change has a capacity window, reports the person’s committed, proposed and projected peak allocation, the projected available percent and whether the change over-allocates them. The peaks count every overlapping commitment of the worker’s person. overlappingMemberships lists only memberships in pods you may see: a pod managed by or under a customer organization is never named. A validation refusal (for example an archived pod, a stale expectedMembershipRevision or a missing correction reason) is a 200 with status: "blocked" and the Console’s code and message. An unknown pod and a pod managed by or under a customer organization both return the same 404. Requires workforce:manage at the platform scope; a key or app whose grant covers only some org units receives 403. The preview is a read carried in a POST body, so it takes no Idempotency-Key.

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.

Body

application/json

One pod membership change to preview, in the Console's operation shape: add, change-effective, update-future or end. Unknown fields are refused.

operation
object
required

Response

Success

data
object
required

ready: the pod, the worker's ID, name and type, the operation to confirm and, when the change has a capacity window, the person's capacity numbers with overlapping memberships in pods the caller may see. blocked: a refusal code and message, as the Console shows them.

meta
object
required