visits.start

Mark a visit started (from scheduled, on the way, or arrived). The worker on the visit (or the office) can do this.

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

When to use it

Mark a visit started (from scheduled, on the way, or arrived). 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

Example

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