visits.onTheWay
Mark that the worker is on the way to a visit, with an optional ETA (eta_at, or eta_minutes from now). The worker on the visit (or the office) can do this. When the shop has on the way notices on, the customer gets a text and an email. Text is the main one. The email goes whenever the customer has an email address, even if the text is blocked, refused, or does not go through. When arrival notices are also on, the message includes an arrival time: a route estimate when the visit already has one, otherwise the time the worker entered, otherwise no arrival line. Route data stores the booked start and the arrival window, not a drive time. Doing Work does not look up a drive time.
| Who | Agents can call this |
| REST | POST /v1/visits/on-the-way |
| MCP tool | visits_onTheWay |
| Writes | yes, send an Idempotency-Key |
| Area | Scheduling and visits |
When to use it
Mark that the worker is on the way to a visit, with an optional ETA (eta_at, or eta_minutes from now). 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
| Field | Type | Required |
|---|---|---|
visit_id | string (uuid) | yes |
eta_at | string (date-time) | no |
eta_minutes | integer | no |
Example
POST https://doingwork.work/v1/visits/on-the-way
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. |