Skip to content

Replace availability rules and/or date overrides for a schedule

PATCH
/appointments/schedules/{schedule_id}/availability

Replace weekly availability rules and/or date overrides for a schedule.

Body: {"availability": [...], "overrides": [...]}

  • availability: list of {days, start_time, end_time} - replaces ALL weekly rules.
  • overrides: list of {date, start_time, end_time} - replaces ALL date overrides.

Omit a key to leave that set unchanged. At least one key is required. Mirrors the in-app PATCH /schedules/{id}/availability logic verbatim. Typed via UpdateAvailabilityRequest so malformed items fail at FastAPI validation (422) rather than as an opaque 500.

Authorizations

Parameters

Path Parameters

schedule_id
required

Schedule integer ID.

integer
>= 1

Schedule integer ID.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
availability
Any of:
Array<object>
object
days
required
Array<integer>
end_time
required
string
start_time
required
string
overrides
Any of:
Array<object>
object
date
required
string
end_time
required
string
start_time
required
string

Responses

200

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string