Update a visit request
/v1/visit-requests/{id}Changes the fields you send and returns the updated visit request. Send null to clear an optional field. Available to keys belonging to office staff and caregivers. With a caregiver's or patient's key, a saved record that key cannot read back is answered with only object and id. Requires a key with write scope.
Path parameters
ID of the visit request.
Request body
application/jsonThe patient the caregiver would visit.
Patient's display name.
First date the caregiver could start.
Last date of the request.
Time of day the caregiver prefers.
Why the caregiver is asking.
Where the request stands. A caregiver's key creates Pending requests and can only change its own pending request to Cancelled; approving and denying is for office staff.
PendingApprovedDeniedCancellednullThe office's reply. Set by office staff.
Response
200The updated visit request.
String representing the object's type. Always visit_request.
Unique identifier of the visit request.
The caregiver asking for the visit. With a caregiver's API key this is always that caregiver (leave it out); office staff must send it.
Caregiver's display name, taken from the caregiver's record.
The patient the caregiver would visit.
Patient's display name.
First date the caregiver could start.
Last date of the request.
Time of day the caregiver prefers.
Why the caregiver is asking.
Where the request stands. A caregiver's key creates Pending requests and can only change its own pending request to Cancelled; approving and denying is for office staff.
PendingApprovedDeniedCancellednullThe office's reply. Set by office staff.
Who answered the request.
When the request was answered.
When the visit request was created.
When the visit request was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.