Jobs

Assigns people to a job — additively by default, or as the complete new crew with `replace: true`.

Requires the Scheduling module. User ids come from GET /api/v1/users and must be active members of the organization. People already on the job keep their crew (schedule group) context; newly added people are assigned as individuals. With replace: true anyone not listed is unassigned (an empty list clears the job). Requires an Idempotency-Key header.

post/api/v1/jobs/{id}/assignees

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/jobs/{id}/assignees
  • Auth: HTTP bearer

Path parameters

idinteger required

Job id from a list response.

Request body

userIdsstring[] required

Identity user ids (see GET /api/v1/users) to assign. All must be active members of the organization.

replaceboolean

true: the list becomes the complete set of assignees (people not listed are unassigned; an empty list unassigns everyone). false (default): the listed people are added to whoever is already assigned.

Response

Job id and a message listing who was assigned / unassigned (or "Assignments unchanged.").

idinteger

Id of the resource the operation acted on (e.g. the job id).

messagestring nullable

Human-readable confirmation from the service (e.g. "Job started."). May be null.

warningstring nullable

Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

Changes

No recorded changes to this operation across all 1 revision of this API.