Skip to content
HeyX API

Cancel Work Order

Required scope: work_order:cancel

Transition a work order to the cancelled state. The API key creator must have current access to its customer. Cancelling a work order that is already cancelled or completed returns its current state without repeating any side effects.

Generated Reference
POST /public-api/publicapi.v1.WorkOrder/CancelWorkOrder

Marks a work order cancelled. Terminal and not idempotent; cancelling an already-terminal work order returns it unchanged without re-emitting.

Request CancelWorkOrderRequest
Response CancelWorkOrderResponse

CancelWorkOrderRequest

Field Type Description
id string Identifies the work order to cancel. Must be visible to the API key actor.

CancelWorkOrderResponse

Field Type Description
work_order WorkOrder The work order after cancellation.

Related Types

WorkOrder

Field Type
id string
customer_id string
title string
description string
status string
created_at int64
updated_at int64
customer_reference_number string
customer_title string
total_tasks int32
completed_tasks int32
work_order_template_id optional string

Request

Section titled “Request”
{
  "id": "<work-order-id>"
}

Response

Section titled “Response”
{
  "workOrder": {
    "id": "<work-order-id>",
    "title": "Install replacement inverter",
    "status": "cancelled"
  }
}

This is not idempotent; do not blindly retry a timed-out call.

HeyX API