Updates an existing calendar on the user's calendar list. Try it now or see an example.
Request
HTTP request
PUT https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId
Parameters
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.
|
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/calendar |
For more information, see the authentication and authorization page.
Request body
In the request body, supply a CalendarList resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
Optional Properties | |||
backgroundColor |
string |
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. |
writable |
colorId |
string |
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. |
writable |
defaultReminders[] |
list |
The default reminders that the authenticated user has for this calendar. | writable |
defaultReminders[].method |
string |
The method used by this reminder. Possible values are:
Required when adding a reminder. |
writable |
defaultReminders[].minutes |
integer |
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. |
writable |
foregroundColor |
string |
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. |
writable |
notificationSettings |
object |
The notifications that the authenticated user is receiving for this calendar. | writable |
notificationSettings.notifications[].method |
string |
The method used to deliver the notification. The possible value is:
Required when adding a notification. |
writable |
notificationSettings.notifications[].type |
string |
The type of notification. Possible values are:
Required when adding a notification. |
writable |
selected |
boolean |
Whether the calendar content shows up in the calendar UI. Optional. The default is False. | writable |
summaryOverride |
string |
The summary that the authenticated user has set for this calendar. Optional. | writable |
Response
If successful, this method returns a CalendarList resource in the response body.
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.CalendarListEntry; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Retrieve the calendar list entry CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute(); // Make a change calendarListEntry.setColorId("newColorId"); // Update the altered entry CalendarListEntry updatedCalendarListEntry = service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute(); System.out.println(updatedCalendarListEntry.getEtag());
Python
Uses the Python client library.
# First retrieve the calendarListEntry from the API. calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute() calendar_list_entry['colorId'] = 'newColorId' updated_calendar_list_entry = service.calendarList().update( calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute() print created_calendar_list_entry['etag']
PHP
Uses the PHP client library.
// First retrieve the calendarListEntry from the API. $calendarListEntry = $service->calendarList->get('calendarId'); $calendarListEntry->setColorId('newColorId'); $updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry); echo $updatedCalendarListEntry->getEtag();
Ruby
Uses the Ruby client library.
calendar_list_entry = client.get_calendar_list('calendarId') calendar_list_entry.colorId = 'newColorId' result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry) print result.etag
Try it!
Use the APIs Explorer below to call this method on live data and see the response.