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 definition to try.

calendar
object
required

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

calendarId
string

Count what is already booked on this calendar against the preview.

Example:

"cal_6b1f2a7c90"

{key}
any

Response

What that definition would offer.

success
boolean
required
data
object
required
{key}
any