Jobs

Moves a job to another status.

Name the target with statusId (one of the organization's status definitions) or statusKey (a status definition name, or a system key such as InProgress / Completed), not both. No transition rules are enforced — any status may follow any other, exactly as in the UI. Requires an Idempotency-Key header.

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

Request

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

Path parameters

idinteger required

Job id from a list response.

Request body

statusIdinteger nullable

Target status definition id (one of the org's statuses).

statusKeystring nullable

Target status by name — a status definition name (case-insensitive) or a system status key such as InProgress, Completed.

notestring nullable

Optional note appended to the status-change history entry.

Response

Job id and confirmation message.

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.