Skip to main content
POST
Preview a direct staffing assignment
Shows what Confirm staffing assignment would do with the same body, without changing anything: the worker, the normalized candidate, the worker’s existing assignments on this project, the capacity effect, the worker’s other commitments on projects you can read (commitments on projects you cannot read are only counted, with their peak percent), project access grant coverage, and blockers (PROJECT_NOT_STAFFABLE, STAFFING_DATE_CONFLICT, OVER_ALLOCATION_REQUIRES_REASON). 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
workerId
string
required

An active Employee or Contractor worker seat linked to a person.

Minimum string length: 1
allocationPercent
number
required

The worker's allocation: whole percent of the worker's capacity, 1 through 100.

startsAt
integer
required

When the assignment starts, epoch milliseconds.

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

The worker's delivery role on the project.

endsAt
integer

When the assignment ends, epoch milliseconds.

Required range: 0 <= x <= 9007199254740991

Response

Success

data
object
required
meta
object
required