Jobs

Transition job status

Update a job's status. For T_FAILED, a reason is required. Status history is recorded automatically.

post/v1/jobs/{jobId}/status

Request

  • Base URL: https://api.workwing.io
  • URL: https://api.workwing.io/v1/jobs/{jobId}/status
  • Auth: HTTP bearer

Path parameters

jobIdstring uuid required

Headers

Idempotency-Keystring required

Unique per write, 1-256 printable ASCII characters. Retrying with the same key and the same request replays the original response for 24 hours. See Idempotency.

Request body

status'T_PENDING' | 'T_SCHEDULED' | 'T_ASSIGNED' | 'T_IN_PROGRESS' | 'T_ON_HOLD' | 'T_INCOMPLETE' | 'T_REBOOK' | 'T_COMPLETED' | 'T_CANCELLED' | 'T_FAILED' required
reasonstring

Response

The job after the transition

Changes

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