Search + K

Command Palette

Search for a command to run...

Sign In

calendar.calendarList.update

PUT /users/me/calendarList/{calendarId}
Copy endpoint
https://www.googleapis.com/calendar/v3

Updates an existing calendar on the user's calendar list.

Parameters

path Path Parameters

Name Type
calendarId required

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

string

query Query Parameters

Name Type
colorRgbFormat

Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

boolean
alt

Data format for the response.

"json"
fields

Selector specifying which fields to include in a partial response.

string
key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

string
oauth_token

OAuth 2.0 token for the current user.

string
prettyPrint

Returns response with indentations and line breaks.

boolean
quotaUser

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

string
userIp

Deprecated. Please use quotaUser instead.

string

Request Body

application/json
interface CalendarListEntry {
accessRole?: string;
autoAcceptInvitations?: boolean;
backgroundColor?: string;
colorId?: string;
conferenceProperties?: ConferenceProperties
interface ConferenceProperties {
allowedConferenceSolutionTypes?: string[];
}
;
dataOwner?: string;
defaultReminders?: EventReminder
interface EventReminder {
method?: string;
minutes?: number;
}
[]
;
deleted?: boolean;
description?: string;
etag?: string;
foregroundColor?: string;
hidden?: boolean;
id?: string;
kind?: string;
location?: string;
notificationSettings?: { notifications?: CalendarNotification
interface CalendarNotification {
method?: string;
type?: string;
}
[]
; }
;
primary?: boolean;
selected?: boolean;
summary?: string;
summaryOverride?: string;
timeZone?: string;
}

Responses

200 */*

Successful response

interface CalendarListEntry {
accessRole?: string;
autoAcceptInvitations?: boolean;
backgroundColor?: string;
colorId?: string;
conferenceProperties?: ConferenceProperties
interface ConferenceProperties {
allowedConferenceSolutionTypes?: string[];
}
;
dataOwner?: string;
defaultReminders?: EventReminder
interface EventReminder {
method?: string;
minutes?: number;
}
[]
;
deleted?: boolean;
description?: string;
etag?: string;
foregroundColor?: string;
hidden?: boolean;
id?: string;
kind?: string;
location?: string;
notificationSettings?: { notifications?: CalendarNotification
interface CalendarNotification {
method?: string;
type?: string;
}
[]
; }
;
primary?: boolean;
selected?: boolean;
summary?: string;
summaryOverride?: string;
timeZone?: string;
}