Jobs

Update a job

Update one job. Send only the fields to change; the response is the updated job.

status is not writable here: move the lifecycle with POST /v1/jobs/{jobId}/status, and assign people with POST /v1/jobs/{jobId}/assignments.

Requires an Idempotency-Key header.

patch/v1/jobs/{jobId}

Request

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

Path parameters

jobIdstring uuid required

The job's id

Query parameters

selectstring

Comma-separated columns to return. Supports embedded resources: *,customer:customers(name,email)

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'

Filterable, not writable here. Sending it answers 409 E_AP_4011; move the lifecycle with POST /v1/jobs/{id}/status.

priority'T_LOW' | 'T_NORMAL' | 'T_HIGH' | 'T_URGENT'
titlestring
notesstring
internal_notesstring

Staff-only notes. Accepted on update but never returned over the API.

scheduled_startstring date-time
scheduled_endstring date-time

Response

The updated job

Changes

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