Calendars: update
Stay organized with collections
Save and categorize content based on your preferences.
Updates metadata for a calendar.
Try it now.
Request
HTTP request
PUT https://www.googleapis.com/calendar/v3/calendars/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.
|
Authorization
This request requires authorization with at least one of the following scopes:
| Scope |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendars |
For more information, see the authentication and authorization page.
Request body
In the request body, supply a Calendars resource with the following properties:
| Property name |
Value |
Description |
Notes |
| Optional Properties |
description |
string |
Description of the calendar. Optional. |
writable
|
location |
string |
Geographic location of the calendar as free-form text. Optional. |
writable
|
summary |
string |
Title of the calendar. |
writable
|
timeZone |
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
writable
|
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-30 UTC.
[null,null,["Last updated 2025-05-30 UTC."],[],[],null,["# Calendars: update\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates metadata for a calendar.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPUT https://www.googleapis.com/calendar/v3/calendars/calendarId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `calendarId` | `string` | Calendar identifier. To retrieve calendar IDs call the [calendarList.list](/workspace/calendar/api/v3/reference/calendarList/list) method. If you want to access the primary calendar of the currently logged in user, use the \"`primary`\" keyword. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|--------------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.app.created` |\n| `https://www.googleapis.com/auth/calendar.calendars` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nIn the request body, supply a [Calendars resource](/workspace/calendar/api/v3/reference/calendars#resource) with the following properties:\n\n| Property name | Value | Description | Notes |\n|---------------|----------|----------------------------------------------------------------------------------------------------------------|----------|\n| **Optional Properties** ||||\n| `description` | `string` | Description of the calendar. Optional. | writable |\n| `location` | `string` | Geographic location of the calendar as free-form text. Optional. | writable |\n| `summary` | `string` | Title of the calendar. | writable |\n| `timeZone` | `string` | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional. | writable |\n\nResponse\n--------\n\nIf successful, this method returns a [Calendars resource](/workspace/calendar/api/v3/reference/calendars#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
