---
title: "Update work order"
method: PATCH
path: "/workorders/{id}"
tags: ["Work Orders"]
---

# Update work order

`PATCH /workorders/{id}`

## Path parameters

- `id` integer, required

## Query parameters

- `expand` string[] — To expand multiple fields: `expand=assignees&expand=asset`
- `skipWebhook` boolean

## Request body

- object
  - `assetId` integer, nullable
  - `assignees` object[] — Either the teamId, the userId or the user email address
    - `type` 'USER' | 'TEAM', required
    - `id` union, required
      - integer
      - string
  - `requesterId` union — ID or email of the user who requested the work order
    - integer, nullable
    - string
  - `categories` string[] — List of categories that identify the work order
  - `description` string, nullable
  - `dueDate` string, date-time, nullable — Date & time at which the work order is due
  - `estimatedTime` integer, nullable — The estimated time taken in seconds to complete the work order
  - `externalData` union — Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
    - object
    - number
    - string
  - `startDate` string, date-time, nullable — Date & time at which the work order will show up in the inbox</br>Only valid when <b>dueDate</b> is set
  - `locationId` integer, nullable — Global ID of the location assigned to the work order
  - `priority` 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH'
  - `procedure` object, nullable
    - `id` number — You should favor 'procedureTemplateId' to attach a procedure template.
    - `title` string, required — Title of the procedure
    - `fields` object[], required — Steps of a procedure
      - `label` string, required
      - `type` 'NUMBER' | 'AMOUNT' | 'TEXT' | 'UNSUPPORTED' | 'HEADING' | 'FILE' | 'SIGNATURE' | 'MULTIPLE_CHOICE' | 'INSPECTION_CHECK' | 'YES_NO_NA' | 'CHECKBOX' | 'CHECKLIST' | 'METER' | 'DATE' | 'CYCLE_COUNT', required
      - `description` string, nullable
      - `choices` string[]
      - `urls` object[]
        - `label` string — Label of the url
        - `link` string, required — Link
      - `meterId` number, nullable — Id of the meter
      - `isDateAndTime` boolean — Indicate if a DATE field also contains the time
      - `index` number — Order which the row is displayed
  - `procedureTemplateId` number, nullable — ID of the procedure template to attach
  - `recurrenceInfo` union
    - object, nullable
      - `type` 'DAILY', required
      - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
        - `automationTriggerInput` object
          - `conditions` object[], required — Conditions to trigger automation
            - `operator` 'increasedBy' | 'decreasedBy', required — Operator for the condition
            - `value` number, required — Value for the condition
          - `meterId` integer, required — ID of the meter to trigger the automation
        - `lastTriggerValue` number — Last trigger value for the meter
        - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
    - object, nullable
      - `type` 'WEEKLY', required
      - `interval` integer — Number of weeks between events
      - `days` string[], required — Days of the week the event will occur
      - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
        - `automationTriggerInput` object
          - `conditions` object[], required — Conditions to trigger automation
            - `operator` 'increasedBy' | 'decreasedBy', required — Operator for the condition
            - `value` number, required — Value for the condition
          - `meterId` integer, required — ID of the meter to trigger the automation
        - `lastTriggerValue` number — Last trigger value for the meter
        - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
    - object, nullable
      - `type` 'MONTHLY', required
      - `interval` integer — Number of months between events
      - `day` integer, required — Day of the month the event will occur
      - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
        - `automationTriggerInput` object
          - `conditions` object[], required — Conditions to trigger automation
            - `operator` 'increasedBy' | 'decreasedBy', required — Operator for the condition
            - `value` number, required — Value for the condition
          - `meterId` integer, required — ID of the meter to trigger the automation
        - `lastTriggerValue` number — Last trigger value for the meter
        - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
    - object, nullable
      - `type` 'YEARLY', required
      - `interval` integer — Number of years between events
      - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
        - `automationTriggerInput` object
          - `conditions` object[], required — Conditions to trigger automation
            - `operator` 'increasedBy' | 'decreasedBy', required — Operator for the condition
            - `value` number, required — Value for the condition
          - `meterId` integer, required — ID of the meter to trigger the automation
        - `lastTriggerValue` number — Last trigger value for the meter
        - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
    - object, nullable
      - `type` 'PERIODICALLY', required
      - `interval` integer — Number of seconds between events
      - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
        - `automationTriggerInput` object
          - `conditions` object[], required — Conditions to trigger automation
            - `operator` 'increasedBy' | 'decreasedBy', required — Operator for the condition
            - `value` number, required — Value for the condition
          - `meterId` integer, required — ID of the meter to trigger the automation
        - `lastTriggerValue` number — Last trigger value for the meter
        - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
  - `title` string
  - `type` 'OTHER' | 'REACTIVE' | 'PREVENTIVE' — Valid types of Work Orders.
  - `extraFields` object — Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Estimated Time Allotted")
  - `vendorIds` number[] — Vendor IDs
  - `partsUsed` object[] — Parts IDs and quantities used in this work order
    - `partId` integer, required — Global ID of the part
    - `quantityUsed` integer — Quantity used in the work order.
    - `locationId` integer, nullable — Global ID of the location of the part
    - `copyOnRecurring` 'NoCopy' | 'Copy' | 'Default' — Indicates if the parts will be copied to the next work order in the chain (if applicable).

## Response `200`

Successfully updated work order's information

- object — Work order information
  - `workOrder` object
    - `id` integer, required — Global ID of the work order
    - `sequentialId` integer, required — Organization specific ID of the work order
    - `assetId` integer, nullable
    - `attachments` object[] — List of attachments linked to the work order
      - `id` number, required — Global ID of the attachment
      - `mimeType` string, required — MIME type of the file
      - `fileName` string, required — Attachment's file name
      - `url` string, required — Url of the file. Valid for 60 minutes.
      - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
      - `width` number, nullable — Width if the file is an image
      - `height` number, nullable — Height if the file is an image
    - `categories` string[] — List of categories that identify the work order
    - `completedAt` string, date-time, nullable — Date & time at which the work order was last marked as DONE
    - `completerId` integer, nullable — ID of the user who completed the work order
    - `createdAt` string, date-time, required — Date & time at which the work order was created
    - `creatorId` integer, nullable, required — ID of the user who created the work order
    - `deletedAt` string, date-time, nullable — Date & time at which the work order was deleted
    - `description` string, nullable
    - `dueDateIsFullDay` boolean, nullable
    - `dueDate` string, date-time, nullable — Date & time at which the work order is due
    - `estimatedTime` integer, nullable — The estimated time taken in seconds to complete the work order
    - `externalData` union — Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
      - object
      - number
      - string
    - `isParent` boolean, nullable — If this is a parent work order
    - `lastMessageSentAt` string, date-time, nullable — Date & time at which the last comment was added to the work order
    - `startDate` string, date-time, nullable — Date & time at which the work order will show up in the inbox</br>Only valid when <b>dueDate</b> is set
    - `locationId` integer, nullable — Global ID of the location assigned to the work order
    - `nextId` integer, nullable
    - `organizationId` number, required
    - `parentId` integer, nullable — The ID of the parent work order
    - `partsAvailability` 'PARTS_AVAILABLE' | 'PARTS_UNAVAILABLE' | 'PARTIAL_PARTS' | 'PARTS_AVAILABLE_BUT_OVERCOMMITTED' — Computed parts availability for this work order based on current inventory levels.
    - `partStatus` 'NO_PARTS' | 'ASSIGNED' | 'RESERVED' | 'KITTED' | 'STAGED' | 'ISSUED' — Part stage indicates the current readiness state of parts for this work order.
    - `previousId` integer, nullable
    - `priority` 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH'
    - `recurrenceInfo` union
      - object, nullable
        - `type` 'DAILY', required
        - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
          - `automationTriggerInput` object
            - `conditions` object[], required — Conditions to trigger automation
              - …
            - `meterId` integer, required — ID of the meter to trigger the automation
          - `lastTriggerValue` number — Last trigger value for the meter
          - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
      - object, nullable
        - `type` 'WEEKLY', required
        - `interval` integer — Number of weeks between events
        - `days` string[], required — Days of the week the event will occur
        - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
          - `automationTriggerInput` object
            - `conditions` object[], required — Conditions to trigger automation
              - …
            - `meterId` integer, required — ID of the meter to trigger the automation
          - `lastTriggerValue` number — Last trigger value for the meter
          - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
      - object, nullable
        - `type` 'MONTHLY', required
        - `interval` integer — Number of months between events
        - `day` integer, required — Day of the month the event will occur
        - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
          - `automationTriggerInput` object
            - `conditions` object[], required — Conditions to trigger automation
              - …
            - `meterId` integer, required — ID of the meter to trigger the automation
          - `lastTriggerValue` number — Last trigger value for the meter
          - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
      - object, nullable
        - `type` 'YEARLY', required
        - `interval` integer — Number of years between events
        - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
          - `automationTriggerInput` object
            - `conditions` object[], required — Conditions to trigger automation
              - …
            - `meterId` integer, required — ID of the meter to trigger the automation
          - `lastTriggerValue` number — Last trigger value for the meter
          - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
      - object, nullable
        - `type` 'PERIODICALLY', required
        - `interval` integer — Number of seconds between events
        - `automationMeterTrigger` object, nullable — Automation meter trigger configuration
          - `automationTriggerInput` object
            - `conditions` object[], required — Conditions to trigger automation
              - …
            - `meterId` integer, required — ID of the meter to trigger the automation
          - `lastTriggerValue` number — Last trigger value for the meter
          - `newDueDateOffsetSeconds` integer — Offset in seconds for new due date. If you want to set the due date to 2 days from now set this to 172800 - (24 * 60 * 60 * 2)
    - `requesterId` integer, nullable — ID of the user who requested the work order through the Work Request feature
    - `status` 'OPEN' | 'IN_PROGRESS' | 'ON_HOLD' | 'DONE' | 'CANCELED' | 'SKIPPED', required — <br /><em>Note:</em> It is also possible to register a webhook to get notified when the status of any work order changes. Please see the <a href="#tag/Subscriptions">Subscriptions</a> section for more information.
    - `thumbnail` object, nullable
      - `id` number, required — Global ID of the attachment
      - `mimeType` string, required — MIME type of the file
      - `fileName` string, required — Attachment's file name
      - `url` string, required — Url of the file. Valid for 60 minutes.
      - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
      - `width` number, nullable — Width if the file is an image
      - `height` number, nullable — Height if the file is an image
    - `title` string, required
    - `type` 'CYCLE_COUNT' | 'OTHER' | 'PREVENTIVE' | 'REACTIVE', nullable — Valid types of Work Orders, including options that are not available for creation/update. Historical Work Orders may have a null type.
    - `updatedAt` string, date-time, required — Date & time at which the work order was last updated. This doesn't include comments
    - `extraFields` object — Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Estimated Time Allotted")
    - `vendorIds` number[] — Vendor IDs
    - `assigneeIds` integer[] — List of user ids assigned to the work order
    - `teamIds` integer[] — List of team ids assigned to the work order
    - `customerId` integer, nullable — ID of the customer linked to the work order
    - `procedure` object, nullable — Procedure attached to the work order
      - `id` number — ID representing a procedure
      - `templateIds` number[], nullable — IDs of the procedure template of the procedure
      - `title` string, required — Title of the procedure
      - `maxScore` number — Maximum score of a procedure
      - `score` number — Score of a procedure
      - `fields` object[], required
        - `id` number, required — ID of the procedure field
        - `parentId` number, nullable — ID of the parent of the current procedure field
        - `procedureTemplateId` number, nullable — ID of the procedure template this field originated from.
        - `procedureTemplateFieldId` number, nullable — ID of the procedure template field this field originated from.
        - `required` boolean, required — Indicate if field is required to be filled.
        - `description` string, nullable — Description of the procedure field
        - `type` 'NUMBER' | 'AMOUNT' | 'TEXT' | 'UNSUPPORTED' | 'HEADING' | 'FILE' | 'SIGNATURE' | 'MULTIPLE_CHOICE' | 'INSPECTION_CHECK' | 'YES_NO_NA' | 'CHECKBOX' | 'CHECKLIST' | 'METER' | 'DATE' | 'CYCLE_COUNT', required — Type of procedure field
        - `label` string, required — Label of a procedure field
        - `maxScore` number — Maximum score of a procedure field
        - `score` number — Score of a procedure field
        - `value` object, required — Current value of a procedure field
          - `text` string, nullable
          - `attachment` object
            - `id` number, required — Global ID of the attachment
            - `mimeType` string, required — MIME type of the file
            - `fileName` string, required — Attachment's file name
            - `url` string, required — Url of the file. Valid for 60 minutes.
            - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
            - `width` number, nullable — Width if the file is an image
            - `height` number, nullable — Height if the file is an image
          - `attachments` object[]
            - `id` number, required — Global ID of the attachment
            - `mimeType` string, required — MIME type of the file
            - `fileName` string, required — Attachment's file name
            - `url` string, required — Url of the file. Valid for 60 minutes.
            - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
            - `width` number, nullable — Width if the file is an image
            - `height` number, nullable — Height if the file is an image
          - `notes` object, nullable — Note added to a procedure field
            - `text` string
          - `hasAttachments` boolean, nullable
        - `meter` object, nullable — Meter of a procedure field. Will be filled if the type of the field is meter
          - `id` number — Global ID of the meter.
          - `name` string — Name of the meters
        - `assignees` object, nullable
          - `userIds` number[]
          - `teamIds` number[]
        - `isDateAndTime` boolean, nullable — Indicate if a DATE field also contains the time
    - `progress` object, nullable — Progress information on the work order
      - `openCount` number
      - `inProgressCount` number
      - `onHoldCount` number
      - `doneCount` number
    - `workOrderSummary` object, nullable — Work Order Summary. Null when no summary is available.
      - `content` string — The original completion note content
      - `summary` string, nullable — AI-generated summary of the content
      - `authorId` integer, nullable — ID of the user who authored the completion note

## Other responses

- `400` — Could not update the work order
- `401` — Invalid token
- `404` — Could not find the specified Work Order.

---

[API](https://skmtc.net/getmaintainx/apis/maintainx-api.md) · [All operations](https://skmtc.net/getmaintainx/apis/maintainx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getmaintainx/maintainx-api/revisions/ef9153fcac7c/schema)