Skip to main content
POST
Preview a Customer assignment change
Previews one assignment change (assign, change-effective, update-future or end, each with that write’s body as args) as the Console does and changes nothing. status: "ready" carries the pod, the Customer, the operation to confirm and, except for an end, the pod’s capacity with the overlapping assignments on that pod; status: "blocked" carries the refusal code and the Console’s message. It requires workforce:manage at the platform scope, and the credential’s scopes must include workforce:manage; no customers:read is needed. An unknown or unreadable pod or assignment, and a pod managed by or under a customer organization, return 404. It takes no Idempotency-Key and is never replayed.

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-to-Customer assignment change to preview, in the Console's operation shape: assign, change-effective, update-future or end. Unknown fields are refused.

operation
object
required

Response

Success

data
object
required

ready: the pod, the Customer, the operation to confirm and, when the change has a capacity window, the pod's capacity numbers with the overlapping assignments on that pod. blocked: a refusal code and message, as the Console shows them.

meta
object
required