Private preview of the new site. Not live.

visits.create

Book a visit to a job at a time, optionally with the workers going. Overlaps for those workers come back in conflicts.

WhoAgents can call this
RESTPOST /v1/visits
MCP toolvisits_create
Writesyes, send an Idempotency-Key
AreaScheduling 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

FieldTypeRequired
job_idstring (uuid)yes
starts_atstring (date-time)yes
ends_atstring (date-time)yes
titlestringno
notesstringno
assignee_idsarrayno
arrival_window_minutesintegerno

Example

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

{
  "job_id": "00000000-0000-4000-8000-000000000000",
  "starts_at": "...",
  "ends_at": "..."
}

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.