Skip to main content
Update a scheduled call

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Pattern: ^[0-9]{1,19}$

Body

application/json

At least one of start_time, duration_minutes, title, description, invitee_ids, recurrence, time_zone is required.

start_time
string
required

When the call (or the chosen occurrence) starts now (RFC 3339).

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.

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

Everyone to invite: replaces the invite list.

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

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

occurrence_start_time
string

Start of the occurrence that scope this or this_and_following refers to (RFC 3339).

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)$
recurrence
string

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

Required string length: 1 - 500
scope
enum<string>

Which occurrences of a recurring call: all (the default without occurrence_start_time), this (the default with it), or this_and_following.

Available options:
all,
this,
this_and_following
time_zone
string

IANA time zone the recurrence follows.

Maximum string length: 64
title
string

Title invitees see.

Maximum string length: 100

Response

The request has succeeded.

data
object
errors
object[]