calendar.events.patch
Update selected fields of a Google Calendar event with PATCH semantics, optionally notifying guests based on the configured sendUpdates setting.
Instructions
Updates an event. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Event object accepting anyoneCanAddSelf, attachments, attendees, attendeesOmitted, birthdayProperties, colorId, conferenceData, created and 36 more fields; pass it via params or whole via body_file Siblings over the same resource: delete, get, import, insert, instances, list, move, quickAdd, update, watch.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| eventId | Yes | [URL path segment] Event identifier. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON Event object. | |
| calendarId | Yes | [URL path segment] 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 | |
| sendUpdates | No | [query parameter] Guests who should receive notifications about the event update (for example, title changes, etc.). Values: `all` = Notifications are sent to all guests.; `externalOnly` = Notifications are sent to non-Google Calendar guests only.; `none` = No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.. | |
| maxAttendees | No | [query parameter] The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional | |
| request_body | No | Request body of type Event: pass it via `params` (merged into the built body) or whole via `body_file`. | |
| eventLabelVersion | No | [query parameter] Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color manage | |
| sendNotifications | No | [query parameter] Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails | |
| alwaysIncludeEmail | No | [query parameter] Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available | |
| supportsAttachments | No | [query parameter] Whether API client performing operation supports event attachments. Optional. The default is False. | |
| conferenceDataVersion | No | [query parameter] Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Ver |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| end | No | ||
| etag | No | ||
| kind | No | ||
| start | No | ||
| gadget | No | ||
| locked | No | ||
| source | No | ||
| status | No | ||
| colorId | No | ||
| created | No | ||
| creator | No | ||
| iCalUID | No | ||
| summary | No | ||
| updated | No | ||
| htmlLink | No | ||
| location | No | ||
| sequence | No | ||
| attendees | No | ||
| eventType | No | ||
| organizer | No | ||
| reminders | No | ||
| recurrence | No | ||
| visibility | No | ||
| attachments | No | ||
| description | No | ||
| hangoutLink | No | ||
| privateCopy | No | ||
| eventLabelId | No | ||
| transparency | No | ||
| conferenceData | No | ||
| guestsCanModify | No | ||
| anyoneCanAddSelf | No | ||
| attendeesOmitted | No | ||
| recurringEventId | No | ||
| originalStartTime | No | ||
| birthdayProperties | No | ||
| endTimeUnspecified | No | ||
| extendedProperties | No | ||
| focusTimeProperties | No | ||
| guestsCanInviteOthers | No | ||
| outOfOfficeProperties | No | ||
| guestsCanSeeOtherGuests | No | ||
| workingLocationProperties | No |