visits.changeRequests
Customers' requests to move or cancel a visit, from the customer hub, newest first. Defaults to open ones. Owner or office only; answer with visits.answerChange.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/visits/changeRequests |
| MCP tool | visits_changeRequests |
| Writes | no |
| Area | Scheduling and visits |
When to use it
Give a customer one page with everything they have with the shop: hub.createLink makes a link for one customer (shown once; send it yourself, Doing Work sends nothing). On it the customer sees their quotes, jobs, invoices with what is still owed, upcoming visits and requests, opens a quote, pays an invoice, asks to move or cancel a visit, and asks for new work (it arrives as a portal request).
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
status | string (one of open, accepted, declined, withdrawn, all) | no |
visit_id | string (uuid) | no |
limit | integer | no |
Example
GET https://doingwork.work/v1/visits/changeRequests?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
change_requests | array | yes |
change_requests[].change_request_id | string (uuid) | yes |
change_requests[].visit_id | string (uuid) | yes |
change_requests[].job_id | string (uuid) | yes |
change_requests[].customer_id | string (uuid) | yes |
change_requests[].customer_name | string | yes |
change_requests[].kind | string | yes |
change_requests[].preferred_times | ['string', 'null'] | yes |
change_requests[].note | ['string', 'null'] | yes |
change_requests[].visit_starts_at | string (date-time) | yes |
change_requests[].visit_now_starts_at | string (date-time) | yes |
change_requests[].visit_status | string | yes |
change_requests[].status | string | yes |
change_requests[].requested_by | string (uuid) | yes |
change_requests[].created_at | string (date-time) | yes |
change_requests[].answered_by | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
change_requests[].answered_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
change_requests[].answer_note | ['string', 'null'] | yes |
change_requests[].applied | boolean | yes |
{
"change_requests": [
{
"change_request_id": "00000000-0000-4000-8000-000000000000",
"visit_id": "00000000-0000-4000-8000-000000000000",
"job_id": "00000000-0000-4000-8000-000000000000",
"customer_id": "00000000-0000-4000-8000-000000000000",
"customer_name": "...",
"kind": "...",
"preferred_times": "...",
"note": "...",
"visit_starts_at": "...",
"visit_now_starts_at": "...",
"visit_status": "...",
"status": "...",
"requested_by": "00000000-0000-4000-8000-000000000000",
"created_at": "...",
"answered_by": "00000000-0000-4000-8000-000000000000",
"answered_at": "...",
"answer_note": "...",
"applied": true
}
]
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |