Update a Work Order Status
For further work order processing, for example, to create an invoice, you may need to change a work order status.
To update a work order 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 | Your note describing why you’re changing the work order status. |
PUT https://sb2api.servicechannel.com/v3/workorders/88472932/status HTTP/1.1
Authorization: Bearer {access_token}
Content-Type: application/json
{
"Status": {
"Primary": "COMPLETED",
"Extended": "PENDING CONFIRMATION"
},
"Note": "WO completed, waiting for confirmation."
}
Example response:
{
"result": "Status has been changed from '<b>OPEN</b>' to '<b>COMPLETED / PENDING CONFIRMATION</b>' with the following comment 'WO completed, waiting for confirmation.'",
"id": 88472932
}
Response code: HTTP/1.1 200 OK
Important: Providers are usually not allowed to change a work order status to billable. By default, there are two billable statuses: COMPLETED and COMPLETED/CONFIRMED. See About Work Order Life Cycle and Statuses to learn more.