visits.markStep

Mark a guided visit step done or skipped (or open again) when the worker says so. Returns the steps and the next one.

WhoAgents can call this
RESTPOST /v1/visits/steps/mark
MCP toolvisits_markStep
Writesyes, send an Idempotency-Key
AreaScheduling and visits

When to use it

Use these when a worker is heading to, standing at, or just leaving a visit. Everything happens in conversation with the worker: there are no buttons for them to tap and no app to open.

What to tell the owner

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

Input

FieldTypeRequired
visit_idstring (uuid)yes
keystringyes
statestring (one of done, skipped, open)yes
notestringno

Example

POST https://doingwork.work/v1/visits/steps/mark
content-type: application/json
Idempotency-Key: 3f1c...

{
  "visit_id": "00000000-0000-4000-8000-000000000000",
  "key": "...",
  "state": "done"
}

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.