Updates an existing calendar on the user's calendar list.
PUT/users/me/calendarList/{calendarId}
Use it in a workflow
Add a step and choose the Google Calendar connector.
Pick the Calendar.calendar List.update action (under calendarList).
Fill in the fields below, then reference the result from later steps as {{calendarCalendarListUpdate.response.data}}.
Request
Path parameters
calendarIdstringrequired
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
altstring
Data format for the response.
One ofjson
fieldsstring
Selector specifying which fields to include in a partial response.
keystring
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.
oauth_tokenstring
OAuth 2.0 token for the current user.
prettyPrintboolean
Returns response with indentations and line breaks.
quotaUserstring
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIpstring
Deprecated. Please use quotaUser instead.
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
Enter the body as JSON in the step's Body field.
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.
- "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 ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
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.
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.
conferencePropertiesobject
allowedConferenceSolutionTypesarray<string>
The types of conference solutions that are supported for this calendar.
The possible values are:
- "eventHangout"
- "eventNamedHangout"
- "hangoutsMeet" Optional.
defaultRemindersarray<object>
The default reminders that the authenticated user has for this calendar.
methodstring
The method used by this reminder. Possible values are:
- "email" - Reminders are sent via email.
- "popup" - Reminders are sent via a UI popup.
Required when adding a reminder.
minutesinteger (int32)
Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Required when adding a reminder.
deletedboolean
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
Default false
descriptionstring
Description of the calendar. Optional. Read-only.
etagstring
ETag of the resource.
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.
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.
Default false
idstring
Identifier of the calendar.
kindstring
Type of the resource ("calendar#calendarListEntry").
Default "calendar#calendarListEntry"
locationstring
Geographic location of the calendar as free-form text. Optional. Read-only.
notificationSettingsobject
The notifications that the authenticated user is receiving for this calendar.
notificationsarray<object>2 fields
The list of notifications set for this calendar.
primaryboolean
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
Default false
selectedboolean
Whether the calendar content shows up in the calendar UI. Optional. The default is False.
Default false
summarystring
Title of the calendar. Read-only.
summaryOverridestring
The summary that the authenticated user has set for this calendar. Optional.
timeZonestring
The time zone of the calendar. Optional. Read-only.
Returns 200 with an object. Read it in later steps with {{calendarCalendarListUpdate.response.data.<field>}}.
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.
- "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 ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
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.
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.
conferencePropertiesobject
allowedConferenceSolutionTypesarray<string>
The types of conference solutions that are supported for this calendar.
The possible values are:
- "eventHangout"
- "eventNamedHangout"
- "hangoutsMeet" Optional.
defaultRemindersarray<object>
The default reminders that the authenticated user has for this calendar.
methodstring
The method used by this reminder. Possible values are:
- "email" - Reminders are sent via email.
- "popup" - Reminders are sent via a UI popup.
Required when adding a reminder.
minutesinteger (int32)
Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Required when adding a reminder.
deletedboolean
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
Default false
descriptionstring
Description of the calendar. Optional. Read-only.
etagstring
ETag of the resource.
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.
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.
Default false
idstring
Identifier of the calendar.
kindstring
Type of the resource ("calendar#calendarListEntry").
Default "calendar#calendarListEntry"
locationstring
Geographic location of the calendar as free-form text. Optional. Read-only.
notificationSettingsobject
The notifications that the authenticated user is receiving for this calendar.
notificationsarray<object>2 fields
The list of notifications set for this calendar.
primaryboolean
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
Default false
selectedboolean
Whether the calendar content shows up in the calendar UI. Optional. The default is False.
Default false
summarystring
Title of the calendar. Read-only.
summaryOverridestring
The summary that the authenticated user has set for this calendar. Optional.
timeZonestring
The time zone of the calendar. Optional. Read-only.
