Skip to main content
POST
Preview a pod staffing assignment
Shows what staffing the pod’s members on the project from startsAt would do, without changing anything: each eligible member with a default proposal (defaultAllocationPercent, optional defaultDeliveryRole), capacity and existing assignments; the members who cannot be staffed and why; the assignments that would be preserved; the pod’s membershipRevision to confirm at; and blockers (PROJECT_NOT_STAFFABLE, POD_ARCHIVED). A pod managed by a customer organization, or by a unit under one, answers 404 exactly as a missing pod. This is a read carried in a POST body: it changes nothing and takes no Idempotency-Key. Needs workforce:manage at the platform scope (a grant that covers only some org units receives 403) and projects:read at the project’s home: a project that is missing, has no home, or that you cannot read answers 404. Because the answer is a staffing read, the credential’s scopes must include workforce:read and projects:read as well as workforce:manage (otherwise 403 naming the missing one, and nothing changes). A refusal is 400, 404, 409 or 413 and its message ends with the Console’s code in parentheses.

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.

Path Parameters

projectId
string
required

The project's ID (id from GET /api/v2/projects/list).

Minimum string length: 1

Body

application/json
podId
string
required

The pod's ID (from GET /api/v2/workforce/listPods).

Minimum string length: 1
defaultAllocationPercent
number
required

Each member's proposed allocation: whole percent of the worker's capacity, 1 through 100.

startsAt
integer
required

When the pod staffing starts, epoch milliseconds.

Required range: 0 <= x <= 9007199254740991
defaultDeliveryRole
string

The delivery role proposed for every member.

endsAt
integer

When the pod staffing ends, epoch milliseconds.

Required range: 0 <= x <= 9007199254740991

Response

Success

data
object
required
meta
object
required