AveeCare

Create an availability window

post/v1/availability

Creates an availability window and returns it. Send an Idempotency-Key header to make the request safe to retry. 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.

Authorization

Authorization: Bearer ak_...requiredscope: read + write

An AveeCare API key created in Settings → API Keys. This endpoint changes data, so the key needs read + write scope. About authentication

Headers

Idempotency-Key
stringmax length 255

A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.

Request body

application/json
caregiverId
stringrequiredmax length 64

The caregiver.

isAvailable
boolean | null

true when the caregiver can work in this window, false for time off.

recurring
boolean | null

Whether the window repeats weekly.

dayOfWeek
integer | nullmin 0max 6

For weekly windows, the weekday: 0 is Sunday, 6 is Saturday.

startMinute
integer | nullmin 0max 1440

For weekly windows, the start time in minutes after midnight.

endMinute
integer | nullmin 0max 1440

For weekly windows, the end time in minutes after midnight.

intervalWeeks
integer | nullmin 1

For weekly windows, repeat every this many weeks. Defaults to every week.

effectiveFrom
string · date | null

First date a weekly window applies.

effectiveTo
string · date | null

Last date a weekly window applies; null for no end.

startDateTime
string · date-time | null

For one-off windows, when it starts.

endDateTime
string · date-time | null

For one-off windows, when it ends.

isPreferred
boolean | null

Whether these are the caregiver's preferred hours.

reason
string | nullmax length 500

Why the caregiver is unavailable, for time off.

isActive
boolean | null

Whether the window is in effect.

Response

201

The new availability window.

object
stringread-only

String representing the object's type. Always availability.

id
stringread-only

Unique identifier of the availability window.

caregiverId
string | nullmax length 64

The caregiver.

isAvailable
boolean | null

true when the caregiver can work in this window, false for time off.

recurring
boolean | null

Whether the window repeats weekly.

dayOfWeek
integer | nullmin 0max 6

For weekly windows, the weekday: 0 is Sunday, 6 is Saturday.

startMinute
integer | nullmin 0max 1440

For weekly windows, the start time in minutes after midnight.

endMinute
integer | nullmin 0max 1440

For weekly windows, the end time in minutes after midnight.

intervalWeeks
integer | nullmin 1

For weekly windows, repeat every this many weeks. Defaults to every week.

effectiveFrom
string · date | null

First date a weekly window applies.

effectiveTo
string · date | null

Last date a weekly window applies; null for no end.

startDateTime
string · date-time | null

For one-off windows, when it starts.

endDateTime
string · date-time | null

For one-off windows, when it ends.

isPreferred
boolean | null

Whether these are the caregiver's preferred hours.

reason
string | nullmax length 500

Why the caregiver is unavailable, for time off.

isActive
boolean | null

Whether the window is in effect.

createdAt
string · date-time | nullread-only

When the availability window was created.

updatedAt
string · date-time | nullread-only

When the availability window 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.
Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.

Errors

StatusCodeMeaning
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).
409
n/a
The Idempotency-Key was already used with a different request, or that request is still running (idempotency_conflict).
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.