Skip to content
XOS Developers

Delete a work order

Work module

DELETE/work-orders/{id}workOrders.delete

A work order issued against a record, open to bids. Soft-deletes the work order: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability work.work_order.write.
  • OAuth scopes: work.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

workOrders.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the work order.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/work-orders/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.workOrders.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.work_orders.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos work-orders delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f