Skip to main content
POST
Confirm a pod staffing assignment
Records the pod’s staffing of the project and confirms an assignment for each member in selectedWorkers, each with its own allocation, dates, optional delivery role and optional overAllocationReason. Send the membershipRevision from the preview as expectedMembershipRevision; a changed roster is 409 ending (POD_ROSTER_CHANGED). Returns 201 with the pod assignment and the created and preserved staffing assignments. A pod managed by a customer organization, or by a unit under one, answers 404 exactly as a missing pod. 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. Rows never name who created, confirmed, amended, approved or released an assignment; the reasons the caller supplied are kept. Send an Idempotency-Key to make a retry safe; see Project staffing replay.

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

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.

Minimum string length: 1
expectedMembershipRevision
integer
required

The pod's membershipRevision from the preview; a changed roster is 409 POD_ROSTER_CHANGED.

Required range: x >= 0
startsAt
integer
required

When the pod staffing starts, epoch milliseconds.

Required range: 0 <= x <= 9007199254740991
selectedWorkers
object[]
required

The members to staff, each with its own allocation and dates.

endsAt
integer

When the pod staffing ends, epoch milliseconds.

Required range: 0 <= x <= 9007199254740991

Response

Success

data
object
required
meta
object
required