--- title: visits.cancel | Doing Work API description: Cancel a visit that is scheduled, on the way, or arrived. It stays on record with the reason, and customer notices not yet sent for it are dropped. url: https://doingwork.work/docs/reference/visits-cancel/ --- # visits.cancel Cancel a visit that is scheduled, on the way, or arrived. It stays on record with the reason, and customer notices not yet sent for it are dropped. | | | |---|---| | Who | Agents can call this | | REST | `POST /v1/visits/cancel` | | MCP tool | `visits_cancel` | | Writes | yes, send an Idempotency-Key | | Area | [Scheduling and visits](https://doingwork.work/docs/reference/#scheduling-and-visits) | ## When to use it Cancel a visit that is scheduled, on the way, or arrived. It stays on record with the reason, and customer notices not yet sent for it are dropped. ## What to tell the owner Say what you did in plain words and what happens next. ## Input | Field | Type | Required | |---|---|---| | `visit_id` | string (uuid) | yes | | `reason` | string | no | ## Example ```http POST https://doingwork.work/v1/visits/cancel content-type: application/json Idempotency-Key: 3f1c... { "visit_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](https://doingwork.work/docs/errors/). |