Update a shift swap
/v1/shift-swaps/{id}Changes the fields you send and returns the updated shift swap. 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 shift swap.
Request body
application/jsonThe caregiver asked to take the visit.
Display name of the target caregiver.
Why the swap is requested.
Where the swap stands. With a caregiver's key: new swaps are Pending; the asked caregiver changes a Pending swap to Accepted or Declined; the requesting caregiver can change it to Cancelled. AdminApproved and AdminDenied are for office staff.
PendingAcceptedDeclinedCancelledAdminApprovedAdminDeniednullWhen the swap was requested.
Response
200The updated shift swap.
String representing the object's type. Always shift_swap.
Unique identifier of the shift swap.
The visit to hand over.
The caregiver giving up the visit. With a caregiver's API key this is always that caregiver (leave it out), and the visit must be assigned to them; office staff must send it.
Display name of the requesting caregiver, taken from the caregiver's record.
The caregiver asked to take the visit.
Display name of the target caregiver.
Why the swap is requested.
Where the swap stands. With a caregiver's key: new swaps are Pending; the asked caregiver changes a Pending swap to Accepted or Declined; the requesting caregiver can change it to Cancelled. AdminApproved and AdminDenied are for office staff.
PendingAcceptedDeclinedCancelledAdminApprovedAdminDeniednullWhen the swap was requested.
When the target caregiver answered.
When the office answered.
When the shift swap was created.
When the shift swap 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.