API ReferenceWork Orders

Update Client Work Order

Update a client's work order. Supports partial updates. Updatable fields: - title, description, priority - startDate, endDate, startDateAllDay, endDateAllDay - status (label string) - assigneeId - visits: Only applicable on field work orders. When provided, the `visits` array REPLACES the full set of visits for the work order. Include all existing visits you wish to keep or update (with their `id`), and include new visits without an `id`. Any existing visit not included in the request will be removed. Visit booleans default to false when omitted. - checklist: Update the checklist for the work order. When this field is provided, the `checklist` array REPLACES the full set of checklist items on the work order. - Include every existing item you want to keep or modify (identified by `id`). - Any existing item NOT included in this array will be removed. - Each item MUST include an `id`. Items without an `id` are ignored (checklist item creation is not supported).

Authentication

x-api-keystring
API Key authentication via header

Path parameters

clientIdstringRequired
Client identifier
workOrderIdstringRequired
Work order identifier

Request

This endpoint expects an object.
titlestringOptional
descriptionstringOptional
priorityintegerOptional
startDatestringOptionalformat: "date-time"
startDateAllDaybooleanOptional
endDatestringOptionalformat: "date-time"
endDateAllDaybooleanOptional
statusstringOptional
Status label
assigneeIdintegerOptional
User identifier to assign to the work order
collaboratorslist of integersOptional
User identifiers to assign as collaborators to the work order
visitslist of objectsOptional

Only applicable on field work orders. When provided, the visits array REPLACES the full set of visits for the work order. Include all existing visits you wish to keep or update (with their id), and include new visits without an id. Any existing visit not included in the request will be removed. Visit booleans default to false when omitted.

checklistlist of objectsOptional
Update the checklist for the work order. When this field is provided, the `checklist` array REPLACES the full set of checklist items on the work order. - Include every existing item you want to keep or modify (identified by `id`). - Any existing item NOT included in this array will be removed. - Each item MUST include an `id`. Items without an `id` are ignored (checklist item creation is not supported).

Response

Work order updated successfully
idinteger or null
Work order identifier
uidinteger or null
Unique work order number within the project
templateIdinteger or null
Template identifier for the work order
createdAtstring or nullformat: "date-time"
Creation timestamp
updatedAtstring or nullformat: "date-time"
Last update timestamp
titlestring or null
Work order title
descriptionstring or null
Work order description
priorityinteger or null
Priority level
startDatestring or nullformat: "date-time"
Scheduled start date
startDateAllDayboolean or null

Whether the start date is an all-day event

endDatestring or nullformat: "date-time"
Scheduled end date
endDateAllDayboolean or null

Whether the end date is an all-day event

completedAtstring or nullformat: "date-time"
Timestamp when the work order was completed
isArchivedboolean or null
Whether the work order is archived
isCompletedboolean or null
Whether the work order is completed
isFieldboolean or null
Whether the work order is a field task
labelslist of objects or null
Labels associated with the work order
projectobject or null
Project associated with the work order
assigneeobject or null
User assigned to the work order
visitsobject or null

Site visits associated with the work order (legacy shape)

statuseslist of objects or null
History of status changes and time spent in each status
statusobject or null
Current status of the work order
checklistlist of objects or null
Checklist items for the work order

Errors