WorkOrders

Update a Work order Status

Updates Work Order status with optional Note. Returns Work order Id for successful request. <br /><br />This method can only be used for users with 'WorkOrderStatusChange' permissions. Available for provider and subscriber usage.

put/workorders/{workorderId}/status

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/workorders/:workorderId/status/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workorderIdinteger required

Numeric Id of the Work order to perform action with.

Request body

Notestring

Optional, Note

Actorstring

Optional, Actor

DeclineReasonIdinteger

Optional, for OPEN/DECLINED status if DeclineHistoryWO FF is on

CustomDeclineReasonstring

Optional, for OPEN/DECLINED status if the decline reason has AskCustomReason=true

Response

Indicates that the request succeeded and that the requested information is in the response.

resultstring

Last note

idinteger

Unique work order identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.