Jobs

Create a job

Create a new job with optional custom fields and job type field validation.

Pass exactly one of customer_id or project_id. With project_id the job is created as one of that project's jobs: customer, brand and default location are inherited, and the job joins the project's pool unscheduled unless scheduled_start/scheduled_end pin it to its own window.

location_id is the site the work happens at and must be one of the job customer's locations. Left out, it falls back to the project's location and then to the customer's primary location.

parent_job_id and kind are never accepted as input.

operator_form_data and resource_form_data are keyed by job type field id and validated against the job type. A number field takes a JSON number (numeric text such as "12.5" is accepted and stored as a number). A signature field takes { "dataUri": "data:image/png;base64,...", "capturedAt": "<ISO 8601>" } (a bare data URI string is accepted and stored in that shape, stamped with the request time). A file field takes an array of file metadata objects or URLs (a single one is accepted and stored as a one-item array).

Scopes: create:jobs and read:jobs (the created job is read back in the response).

post/v1/jobs

Request

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

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

customer_idstring uuid
project_idstring uuid
parent_job_idunknown
kindunknown
template_idstring uuid required
location_idstring uuid
titlestring
notesstring
internal_notesstring
status'T_PENDING' | 'T_SCHEDULED' | 'T_ASSIGNED' | 'T_IN_PROGRESS' | 'T_ON_HOLD' | 'T_INCOMPLETE' | 'T_REBOOK' | 'T_COMPLETED' | 'T_CANCELLED' | 'T_FAILED'
status_notesstring
priority'T_LOW' | 'T_NORMAL' | 'T_HIGH' | 'T_URGENT'
scheduled_startstring date-time
scheduled_endstring date-time
assigned_resource_idstring uuid
resource_group_idstring uuid
custom_fieldsobject
operator_form_dataobject
resource_form_dataobject

Response

Default Response

Changes

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