Skip to main content
Schedule a call

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
start_time
string
required

When the call starts (RFC 3339); not in the past.

Pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d{1,9})?(Z|[+-]([01]\d|2[0-3]):[0-5]\d)$
description
string

What the call is about.

Maximum string length: 1000
duration_minutes
integer

How long the call lasts, in minutes. Defaults to 30; at most 31 days.

Required range: 1 <= x <= 44640
invitee_ids
string[]

X user ids of the people to invite.

Maximum array length: 100
Pattern: ^[0-9]{1,19}$
notify_invitees
boolean

Whether invitees get an email about the call. Defaults to true.

recurrence
string

RFC 5545 RRULE to repeat the call by, such as FREQ=WEEKLY;BYDAY=MO; the RRULE: prefix is optional.

Maximum string length: 500
time_zone
string

IANA time zone the recurrence follows, such as America/Los_Angeles.

Maximum string length: 64
title
string

Title invitees see.

Maximum string length: 100

Response

The request has succeeded.

data
object
errors
object[]