Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-133839143.7 KB
calendarList

Updates an existing calendar on the user's calendar list. This method supports patch semantics.

patch/users/me/calendarList/{calendarId}

Path parameters

calendarIdstring 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.

Query parameters

colorRgbFormatboolean

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.

Request body

autoAcceptInvitationsboolean

Whether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only.

locationstring

Geographic location of the calendar as free-form text. Optional. Read-only.

descriptionstring

Description of the calendar. Optional. Read-only.

etagstring

ETag of the resource.

summaryOverridestring

The summary that the authenticated user has set for this calendar. Optional.

deletedboolean

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

accessRolestring

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:

  • "freeBusyReader" - Provides read access to free/busy information.
  • "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
  • "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden.
  • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
  • "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.
kindstring

Type of the resource ("calendar#calendarListEntry").

primaryboolean

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

colorIdstring

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

hiddenboolean

Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.

selectedboolean

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

dataOwnerstring

The email of the owner of the calendar. Set only for secondary calendars. Read-only.

summarystring

Title of the calendar. Read-only.

timeZonestring

The time zone of the calendar. Optional. Read-only.

backgroundColorstring

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

foregroundColorstring

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

idstring

Identifier of the calendar.

Response

Successful response