CalendarList: patch

Updates an existing calendar on the user's calendar list. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a get followed by an update. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements. Try it now.


HTTP request



Parameter name Value Description
Path parameters
calendarId string 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.
Optional query parameters
colorRgbFormat boolean 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.


This request requires authorization with the following scope:


For more information, see the authentication and authorization page.

Request body

In the request body, supply the relevant portions of a CalendarList resource, according to the rules of patch semantics.


If successful, this method returns a CalendarList resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.