Skip to main content
POST
Release a direct staffing assignment
Ends a direct staffing assignment at endsAt, which must be after its start, not before now, and not after its current end, with a required reason. Send the revision you last read as expectedRevision. 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
assignmentId
string
required

The staffing assignment's ID.

Minimum string length: 1

Body

application/json
expectedRevision
integer
required

The staffing assignment's revision you last read; a stale value is 409 STAFFING_ASSIGNMENT_CHANGED.

Required range: x >= 0
endsAt
integer
required

When the assignment ends (not before now), epoch milliseconds.

Required range: 0 <= x <= 9007199254740991
reason
string
required

Why the assignment is released; required.

Response

Success

data
object
required
meta
object
required