Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

calendarId
string
required

The calendar id.

Minimum string length: 1

Query Parameters

locationId
string
required

The sub-account. Your access to it is checked on every call.

Body

application/json

The settings to change.

A calendar to create, or the parts of one to change. On an update, the calendar is validated as it will be after the change.

name
string
Example:

"Consultations"

timezone
string

Required on create.

Example:

"America/Chicago"

weeklyHours
object

Opening hours by day, keyed by sun, mon, tue, wed, thu, fri, sat. Each day is a list of {start, end} in 24-hour HH:MM, and a day left out is closed. On an update it replaces all the weekly hours, so send every open day.

dateOverrides
object[]

Days that differ from the weekly hours: {date, closed: true}, or {date, windows: [{start, end}]}, with date as YYYY-MM-DD. On an update it replaces the whole list.

slotDurationMinutes
integer

How long an appointment lasts, in minutes. Defaults to 30.

Required range: x >= 1
slotIntervalMinutes
integer

How often a slot starts, in minutes. Defaults to 30. Less than the duration gives slots that overlap.

Required range: x >= 1
slotBufferMinutes
integer

Free time kept before and after each booking, in minutes. Defaults to 0.

Required range: x >= 0
appointmentsPerSlot
integer

How many bookings one slot can hold. Defaults to 1.

Required range: x >= 1
minNoticeMinutes
integer

How many minutes from now the first bookable slot must be. Defaults to 180.

Required range: x >= 0
maxDaysOut
integer

How many days ahead slots are offered. Defaults to 31.

Required range: x >= 1
isActive
boolean

Ignored on create and preview. On an update, false hides the calendar and stops new bookings on it. Booked appointments stay.

{key}
any

Response

The calendar as it now is.

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