online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.workorder.title
Update Custom Status
Overview
Update Work Order custom status in MobiWork
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/workOrder/customStatus/update.html?token=XXXXXXXX&userId={userId}
Arguments
clientId
required
MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: 10.0.78
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
userId
optional
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID
Return
Returns a Work order custom status updated successful message if valid input is provided
Request Body XSD
Response Body XSD
Curl Example
HTTP Method: POST
Request: curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/workOrder/customStatus/update.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request>
<customStatusApiName>completed</customStatusApiName>
<workOrderId>12345</workOrderId>
</request>'
Response: <?xml version="1.0" encoding="UTF-8" ?>
<response version="5.0.141" statusCode="1">New custom status with apiName : completed applied to work orders successfully</response>