Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

locationId
string
required

The sub-account this calendar belongs to. It is the only thing that identifies the tenant here, and access is re-checked against it on every call.

Body

application/json

The calendar.

A calendar to create, or the parts of one to change. On an update the MERGED calendar is validated, not the patch.

name
string
Example:

"Consultations"

timezone
string

Required on create.

Example:

"America/Chicago"

weeklyHours
object
dateOverrides
object[]
slotDurationMinutes
integer
Required range: x >= 1
slotIntervalMinutes
integer
Required range: x >= 1
slotBufferMinutes
integer
Required range: x >= 0
appointmentsPerSlot
integer
Required range: x >= 1
minNoticeMinutes
integer
Required range: x >= 0
maxDaysOut
integer
Required range: x >= 1
isActive
boolean
{key}
any

Response

The calendar as stored, with every default filled in.

success
boolean
required
data
object
required

A bookable calendar: when it is open, how long an appointment lasts, and how far ahead it will go.

{key}
any