API ReferenceWork Orders

Update Project Work Order

Update a project'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). - isActive: Set to `false` to archive the work order, or `true` to unarchive it. Applied independently of any other fields present in the same request.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

project_idintegerRequired
Project identifier
work_order_idintegerRequired
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).
isActiveboolean or nullOptional

Set to false to archive the work order, or true to unarchive it. Applied independently of any other fields present in the same request.

Response

Work order updated successfully
idintegerOptional
Work order identifier
uidintegerOptional
Unique work order number within the project
templateIdintegerOptional
Template identifier for the work order
createdAtstringOptionalformat: "date-time"
Creation timestamp
updatedAtstringOptionalformat: "date-time"
Last update timestamp
titlestringOptional
Work order title
descriptionstringOptional
Work order description
priorityintegerOptional
Priority level
startDatestring or nullOptionalformat: "date-time"
Scheduled start date
startDateAllDaybooleanOptional

Whether the start date is an all-day event

endDatestring or nullOptionalformat: "date-time"
Scheduled end date
endDateAllDaybooleanOptional

Whether the end date is an all-day event

completedAtstring or nullOptionalformat: "date-time"
Timestamp when the work order was completed
isActivebooleanOptional

Whether the work order is active (not archived)

isCompletedbooleanOptional
Whether the work order is completed
isFieldbooleanOptional
Whether the work order is a field task
labelslist of objectsOptional
Labels associated with the work order
projectobjectOptional
Project associated with the work order
assigneeobject or nullOptional
User assigned to the work order
collaboratorslist of objectsOptional
Additional users collaborating on the work order
visitsobjectOptional

Site visits associated with the work order (legacy shape)

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

Work items linked to this work order via Blueprint workflow. Includes forms (FORM) and file requests (FILE_REQUEST). Returns [] when none are linked.

lineItemslist of objectsOptional

Present only for service work orders on an account (parent project type ACCOUNT), and only when at least one line item exists. Amounts are in dollars with cent precision. Replace via PUT /work-orders/{work_order_id}/line-items. Omitted from the response when not applicable or when there are no line items.

isArchivedbooleanOptionalDeprecated

Deprecated: use isActive instead. Kept for backward compatibility.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error