Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json

Input for starting a Google Calendar connection.

calendarConnectionId
string<uuid> | null

Reconnect an existing connection instead of creating one: the consent screen replaces that connection’s credential in place, so every tool bound to it keeps working. Use this when a connection reports INVALID_CREDENTIALS. The connection’s existing name and timezone are kept, so label is ignored when this is set.

label
string | null

Customer-facing name for the connection, unique within the project. Required unless calendarConnectionId is set, and decided now because the consent screen has nowhere to carry it.

Required string length: 1 - 120
timezone
string | null

The named IANA timezone to offer slots in, for example America/Los_Angeles. Omit to adopt the Google account’s own. A fixed offset such as -08:00 is rejected: it does not observe DST.

Minimum string length: 1
loginHint
string<email> | null

The Google account to preselect on the consent screen. A hint only: it is ignored if the user is signed into another account, and nothing is authorized by it.

Response

A URL to open, and when it stops working.

data
CalendarOauthStart · object
required