Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

providerId
string
required

The calendar system, lower case.

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.

Body

application/json

The credential.

token
string
required

The credential, as that product issues it. Not validated against it here.

Example:

"cal_live_0123456789abcdef"

{key}
any

Response

Connected.

success
boolean
required
data
object
required

The connection as it now stands. Never the credential.

{key}
any