Skip to content

Create Calendar Invite

POST
/calendar-invites

Create a calendar invite. Sends nothing; share the returned ics_url.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
description
Any of:
string
duration_minutes
integer
default: 45 >= 1 <= 1440
meeting_link
Any of:
string
start_at
required

Start time WITH a timezone offset.

string format: date-time
title
required
string
>= 1 characters <= 1000 characters
tz
required

IANA timezone the event is shown in, e.g. Europe/London.

string

Responses

201

Successful Response

object
data
required

A calendar invite, including the public ics_url.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string