Skip to main content
DELETE
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 this calendar belongs to. It is the only thing that identifies the tenant here, and access is re-checked against it on every call.

force
enum<string>

Cancel the upcoming appointments and delete anyway.

Available options:
true

Response

The calendar is retired, with what was cancelled if you forced it.

success
boolean
required
data
object
required
{key}
any