Skip to content

Create an availability schedule

POST
/appointments/schedules

Create a named availability schedule with weekly rules and optional date overrides.

Defaults to Mon-Fri 09:00-17:00 when availability is omitted. Pass is_default=True to immediately set this as the caller’s default schedule (persisted via update_appointment_settings).

Authorizations

Parameters

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
is_default
boolean
name
required
string
overrides
Any of:
Array<object>
object
date
required
string
end_time
required
string
start_time
required
string
time_zone
required
string

Responses

201

Successful Response

object
key
additional properties
any

422

Validation Error

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