Google: Updates metadata for a calendar
Google calendarCalendars.calendarCalendarsUpdate: arguments, response, policy and SDK examples.
← Calendar calendars operations · Get started
Operation google.calendar_calendars_update
Provider route: PUT /calendar/v3/calendars/{calendarId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { GoogleIntegration } from "@alter-ai/google";
async function execute(input: Parameters<GoogleIntegration["calendarCalendars"]["calendarCalendarsUpdate"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.calendarCalendars.calendarCalendarsUpdate(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_google import GoogleIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.calendar_calendars.calendar_calendars_update(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.calendarId | string | Required within parent | 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 | Model | Optional | Expand Returns a single user setting — request body — query |
body | Model | Required within parent | Expand Updates metadata for a calendar — request body — body |
Referenced models: Updates metadata for a calendar — request body — body, Returns a single user setting — request body — query
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Returns metadata for a calendar — response body |
Referenced models: Returns metadata for a calendar — response body
Schemas
Section titled “Schemas”Returns metadata for a calendar — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
autoAcceptInvitations | boolean | Optional | Whether this calendar automatically accepts invitations. Only valid for resource calendars. |
conferenceProperties | Model | Optional | Expand Returns metadata for a calendar — response body — conference Properties Conferencing properties for this calendar, for example what types of conferences are allowed. |
dataOwner | string | Optional | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
description | string | Optional | Description of the calendar. Optional. |
etag | string | Optional | ETag of the resource. |
id | string | Optional | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
kind | string | Optional | Type of the resource ("calendar#calendar"). Default: calendar#calendar |
labelProperties | Model | Optional | Expand Returns metadata for a calendar — response body — label Properties Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. |
location | string | Optional | Geographic location of the calendar as free-form text. Optional. |
summary | string | Optional | Title of the calendar. |
timeZone | string | Optional | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
workingHours | object | Optional | Represents the information about the user's working hours. Only available for primary calendars of Google Workspace users. To update the working hours, the entire working hours object must be passed. If not specified (or passed as null or an empty object), the existing working hours remain unchanged. To disable working hours or clear the schedule, set workingHoursEnabled to false (and omit availableTimes or pass an empty list). |
workingHours.availableTimes | array | Optional | Working hours. Each availability period represents the user's working hours block during one day. |
workingHours.availableTimes[] | object | Each item | |
workingHours.availableTimes[].dayOfWeek | string | Optional | Day of the week. Required. Possible values are: - "monday" - "tuesday" - "wednesday" - "thursday" - "friday" - "saturday" - "sunday" |
workingHours.availableTimes[].periodEnd | JSON | Optional | |
workingHours.availableTimes[].periodEnd (anyOf 1) | integer | Alternative | Period end, in minutes from the start of the day, exclusive. Required. Format: int32 |
workingHours.availableTimes[].periodEnd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workingHours.availableTimes[].periodStart | JSON | Optional | |
workingHours.availableTimes[].periodStart (anyOf 1) | integer | Alternative | Period start, in minutes from the start of the day, inclusive. Required. Format: int32 |
workingHours.availableTimes[].periodStart (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workingHours.workingHoursEnabled | boolean | Optional | Whether the working hours are enabled for this calendar. Cannot be set to true when availableTimes is empty. |
Referenced models: Returns metadata for a calendar — response body — conference Properties, Returns metadata for a calendar — response body — label Properties
Updates metadata for a calendar — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
autoAcceptInvitations | boolean | Optional | Whether this calendar automatically accepts invitations. Only valid for resource calendars. |
conferenceProperties | Model | Optional | Expand Returns metadata for a calendar — response body — conference Properties Conferencing properties for this calendar, for example what types of conferences are allowed. |
dataOwner | string | Optional | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
description | string | Optional | Description of the calendar. Optional. |
etag | string | Optional | ETag of the resource. |
id | string | Optional | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
kind | string | Optional | Type of the resource ("calendar#calendar"). Default: calendar#calendar |
labelProperties | Model | Optional | Expand Returns metadata for a calendar — response body — label Properties Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. |
location | string | Optional | Geographic location of the calendar as free-form text. Optional. |
summary | string | Optional | Title of the calendar. |
timeZone | string | Optional | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
workingHours | Model | Optional | Expand Updates metadata for a calendar — request body — body working Hours |
Referenced models: Returns metadata for a calendar — response body — conference Properties, Returns metadata for a calendar — response body — label Properties, Updates metadata for a calendar — request body — body working Hours
Returns a single user setting — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fields | string | Optional | Selector specifying which fields to include in a partial response. |
prettyPrint | boolean | Optional | Returns response with indentations and line breaks. Default: true |
quotaUser | string | Optional | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
userIp | string | Optional | Deprecated. Please use quotaUser instead. |
Returns metadata for a calendar — response body — conference Properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowedConferenceSolutionTypes | array | Optional | The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional. |
allowedConferenceSolutionTypes[] | string | Each item |
Returns metadata for a calendar — response body — label Properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
eventLabels | array | Optional | Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. Each calendar can have a maximum of 200 labels. |
eventLabels[] | Model | Each item | Expand Returns metadata for a calendar — response body — label Properties event Labels item |
Referenced models: Returns metadata for a calendar — response body — label Properties event Labels item
Updates metadata for a calendar — request body — body working Hours
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the information about the user's working hours. Only available for primary calendars of Google Workspace users. To update the working hours, the entire working hours object must be passed. If not specified (or passed as null or an empty object), the existing working hours remain unchanged. To disable working hours or clear the schedule, set workingHoursEnabled to false (and omit availableTimes or pass an empty list). |
availableTimes | array | Optional | Working hours. Each availability period represents the user's working hours block during one day. |
availableTimes[] | Model | Each item | Expand Updates metadata for a calendar — request body — body working Hours available Times item |
workingHoursEnabled | boolean | Optional | Whether the working hours are enabled for this calendar. Cannot be set to true when availableTimes is empty. |
Referenced models: Updates metadata for a calendar — request body — body working Hours available Times item
Returns metadata for a calendar — response body — label Properties event Labels item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
backgroundColor | string | Optional | Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. |
id | string | Optional | The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. If provided, the ID must be unique within the calendar and follow UUID format. |
name | string | Optional | Name of the label. Optional. If provided this must have at most 50 characters. |
Updates metadata for a calendar — request body — body working Hours available Times item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dayOfWeek | string | Optional | Day of the week. Required. Possible values are: - "monday" - "tuesday" - "wednesday" - "thursday" - "friday" - "saturday" - "sunday" |
periodEnd | integer | Optional | Period end, in minutes from the start of the day, exclusive. Required. Format: int32 |
periodStart | integer | Optional | Period start, in minutes from the start of the day, inclusive. Required. Format: int32 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: google.calendar_calendars_update. Catalog operation: calendar.calendars.update. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.calendars"]