Events: patch

Requires authorization

Updates an event. This method supports patch semantics. 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.
eventId string Event identifier.
Optional query parameters
alwaysIncludeEmail boolean Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
conferenceDataVersion integer 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. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. Acceptable values are 0 to 1, inclusive.
maxAttendees integer 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.
sendNotifications boolean Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
supportsAttachments boolean Whether API client performing operation supports event attachments. Optional. The default is False.


This request requires authorization with the following scope (read more about authentication and authorization).


Request body

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


If successful, this method returns an Events resource in the response body.

Try it!

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

Send feedback about...

Calendar API
Calendar API
Need help? Visit our support page.