API ReferenceWork Orders

Update Opportunity Work Order

Update an opportunity's work order. Supports partial updates. **Note:** The `/requests` path is an alias for `/opportunities` and will continue to work until users are individually notified and migrated. 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

opportunityIdintegerRequired
Opportunity identifier
workOrderIdintegerRequired
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
Work order identifier
uidinteger
Unique work order number within the project
templateIdinteger
Template identifier for the work order
createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
titlestring
Work order title
descriptionstring
Work order description
priorityinteger
Priority level
startDatestring or nullformat: "date-time"
Scheduled start date
startDateAllDayboolean

Whether the start date is an all-day event

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

Whether the end date is an all-day event

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

Site visits associated with the work order (legacy shape)

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

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 objects

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/{workOrderId}/line-items. Omitted from the response when not applicable or when there are no line items.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error