visits.done

Mark a visit done, with an optional note. The worker on the visit (or the office) can do this. A visit not yet started is started too. Refused with checklist_open while a checklist on the visit has required items open or a sign-off missing; the owner, signed in on the hosted override page (/p/checklist/override), may pass override_reason to mark it done anyway (recorded and audited). Agents, keys and office staff cannot override.

WhoAgents can call this
RESTPOST /v1/visits/done
MCP toolvisits_done
Writesyes, send an Idempotency-Key
AreaScheduling and visits

When to use it

Mark a visit done, with an optional note. The worker on the visit (or the office) can do this.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
visit_idstring (uuid)yes
notestringno
override_reasonstringno

Example

POST https://doingwork.work/v1/visits/done
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

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.