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

When to use it

Read schedule.settings first: it has the shop's time zone, working hours, arrival window and buffer. Use schedule.findTime to get open times that fit the shop's hours, each worker's hours and time off, and visits already booked with the buffer around them, then book with visits.create.

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

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.