Skip to main content
Create Calendar

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

select
string

Filtering Columns

Body

application/json

calendar

id
string<uuid>
default:random uuid

Calendar ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

name
string<text>

Name of the calendar

type
enum<string>

Calendar type (virtual or provider). Only virtual calendars can be created via the API.

Available options:
virtual,
provider
external_id
string<text> | null

External ID

Response

The updated Calendar object

id
string<uuid>
default:random uuid

Calendar ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

name
string<text>

Name of the calendar

type
enum<string>

Calendar type (virtual or provider). Only virtual calendars can be created via the API.

Available options:
virtual,
provider
external_id
string<text> | null

External ID