Update a Work Order Status

less than 1 minute read

For further WO processing, for example, to create an invoice, you may need to change a work order status.

To update a WO status, send the following request:

PUT /workorders/{workorderId}/status

Header Value
Content-Type application/json
Parameter Parameter type Example value
workorderId Path 88472932
updateRequest Body See below

updateRequest object

Element Data type Required Note
Status.Primary String Required You can use a status Id instead of a full status name, for example, "Primary": "3".
Status.Extended String Optional  
Note String Optional Text

Example request:

PUT https://sb2api.servicechannel.com/workorders/88472932/status HTTP/1.1
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "Status": {
    "Primary": "COMPLETED",
    "Extended": "PENDING CONFIRMATION"
  },
  "Note": "Test note"
}

Example response:

{
  "result": "Status has been changed from '<b>OPEN</b>' to '<b>COMPLETED / PENDING CONFIRMATION</b>' with the following comment 'Test note'",
  "id": 88472932
}

Response code: HTTP/1.1 200 OK

Important: Providers are usually not allowed to change a WO status to billable. By default, there are two billable statuses: COMPLETED and COMPLETED—CONFIRMED. See Status Definitions to learn more about WO statuses.

Updated: