changes.cancel
Cancel a draft or sent change order (its open signature request is cancelled too, so the link stops working). An approved change order cannot be cancelled; write a new change order that takes the work back out.
| Who | Agents can call this |
| REST | POST /v1/change-orders/cancel |
| MCP tool | changes_cancel |
| Writes | yes, send an Idempotency-Key |
| Area | Field work (checklists, forms, time, notes, change orders, subcontractors) |
When to use it
A change order is a priced change to a job's scope: extra work, or a credit for work taken out. A worker writes the lines (changes.create; never fill prices in yourself).
What to tell the owner
Say what you did in plain words and what happens next.
Input
| Field | Type | Required |
|---|---|---|
change_order_id | string (uuid) | yes |
reason | string | no |
Example
POST https://doingwork.work/v1/change-orders/cancel
content-type: application/json
Idempotency-Key: 3f1c...
{
"change_order_id": "00000000-0000-4000-8000-000000000000"
}Output
JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.
Errors
| Code | Status | What to do |
|---|---|---|
invalid_input, invalid_token, rate_limited | Can happen on any call. See errors. |