Updates an event.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.events

If unset, the scope for this method defaults to https://www.googleapis.com/auth/calendar. You can set the scope for this method like this: calendar3 --scope <scope> events update ...

Required Scalar Arguments

  • <calendar-id> (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.
  • <event-id> (string)
    • Event identifier.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Event:
  anyone-can-add-self: boolean
  attendees-omitted: boolean
  color-id: string
  conference-data:
    conference-id: string
    conference-solution:
      icon-uri: string
      key:
        type: string
      name: string
    create-request:
      conference-solution-key:
        type: string
      request-id: string
      status:
        status-code: string
    notes: string
    parameters:
      add-on-parameters:
        parameters: { string: string }
    signature: string
  created: string
  creator:
    display-name: string
    email: string
    id: string
    self: boolean
  description: string
  end:
    date: string
    date-time: string
    time-zone: string
  end-time-unspecified: boolean
  etag: string
  event-type: string
  extended-properties:
    private: { string: string }
    shared: { string: string }
  focus-time-properties:
    auto-decline-mode: string
    chat-status: string
    decline-message: string
  gadget:
    display: string
    height: integer
    icon-link: string
    link: string
    preferences: { string: string }
    title: string
    type: string
    width: integer
  guests-can-invite-others: boolean
  guests-can-modify: boolean
  guests-can-see-other-guests: boolean
  hangout-link: string
  html-link: string
  i-cal-uid: string
  id: string
  kind: string
  location: string
  locked: boolean
  organizer:
    display-name: string
    email: string
    id: string
    self: boolean
  original-start-time:
    date: string
    date-time: string
    time-zone: string
  out-of-office-properties:
    auto-decline-mode: string
    decline-message: string
  private-copy: boolean
  recurrence: [string]
  recurring-event-id: string
  reminders:
    use-default: boolean
  sequence: integer
  source:
    title: string
    url: string
  start:
    date: string
    date-time: string
    time-zone: string
  status: string
  summary: string
  transparency: string
  updated: string
  visibility: string
  working-location-properties:
    custom-location:
      label: string
    office-location:
      building-id: string
      desk-id: string
      floor-id: string
      floor-section-id: string
      label: string
    type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . anyone-can-add-self=false
    • Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.
  • attendees-omitted=true
    • Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
  • color-id=accusam
    • The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
  • conference-data conference-id=et
    • The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type:
      • eventHangout: ID is not set. (This conference type is deprecated.)
      • eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)
      • hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
      • addOn: ID is defined by the third-party provider. Optional.
  • conference-solution icon-uri=nonumy
    • The user-visible icon for this solution.

  • key type=accusam

    • The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are:
      • "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)
      • "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)
      • "hangoutsMeet" for Google Meet (http://meet.google.com)
      • "addOn" for 3P conference providers

  • .. name=ut

    • The user-visible name of this solution. Not localized.

  • ..create-request.conference-solution-key type=voluptua.

    • The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are:
      • "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)
      • "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)
      • "hangoutsMeet" for Google Meet (http://meet.google.com)
      • "addOn" for 3P conference providers

  • .. request-id=consetetur

    • The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.

  • status status-code=dolor

    • The current status of the conference create request. Read-only. The possible values are:
      • "pending": the conference create request is still being processed.
      • "success": the conference create request succeeded, the entry points are populated.
      • "failure": the conference create request failed, there are no entry points.

  • ... notes=amet

    • Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.

  • parameters.add-on-parameters parameters=key=et

    • No description provided.
    • the value will be associated with the given key

  • ... signature=aliquyam

    • The signature of the conference data. Generated on server side. Unset for a conference with a failed create request. Optional for a conference with a pending create request.

  • .. created=ipsum

    • Creation time of the event (as a RFC3339 timestamp). Read-only.
  • creator display-name=gubergren
    • The creator's name, if available.
  • email=invidunt
    • The creator's email address, if available.
  • id=sea
    • The creator's Profile ID, if available.

  • self=true

    • Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

  • .. description=stet

    • Description of the event. Can contain HTML. Optional.
  • end date=sadipscing
    • The date, in the format "yyyy-mm-dd", if this is an all-day event.
  • date-time=no
    • The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

  • time-zone=tempor

    • The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.

  • .. end-time-unspecified=true

    • Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
  • etag=sea
    • ETag of the resource.
  • event-type=sit
    • Specific type of the event. This cannot be modified after the event is created. Possible values are:
      • "default" - A regular event or not further specified.
      • "outOfOffice" - An out-of-office event.
      • "focusTime" - A focus-time event.
      • "workingLocation" - A working location event. Currently, only "default " and "workingLocation" events can be created using the API. Extended support for other event types will be made available in later releases.
  • extended-properties private=key=amet.
    • Properties that are private to the copy of the event that appears on this calendar.
    • the value will be associated with the given key

  • shared=key=ipsum

    • Properties that are shared between copies of the event on other attendees' calendars.
    • the value will be associated with the given key

  • ..focus-time-properties auto-decline-mode=at

    • Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined.
  • chat-status=vero
    • The status to mark the user in Chat and related products. This can be available or doNotDisturb.

  • decline-message=takimata

    • Response message to set if an existing event or new invitation is automatically declined by Calendar.

  • ..gadget display=gubergren

    • The gadget's display mode. Deprecated. Possible values are:
      • "icon" - The gadget displays next to the event's title in the calendar view.
      • "chip" - The gadget displays when the event is clicked.
  • height=27
    • The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.
  • icon-link=invidunt
    • The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.
  • link=magna
    • The gadget's URL. The URL scheme must be HTTPS. Deprecated.
  • preferences=key=sit
    • Preferences.
    • the value will be associated with the given key
  • title=gubergren
    • The gadget's title. Deprecated.
  • type=elitr
    • The gadget's type. Deprecated.

  • width=51

    • The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

  • .. guests-can-invite-others=true

    • Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
  • guests-can-modify=false
    • Whether attendees other than the organizer can modify the event. Optional. The default is False.
  • guests-can-see-other-guests=true
    • Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
  • hangout-link=lorem
    • An absolute link to the Google Hangout associated with this event. Read-only.
  • html-link=dolores
    • An absolute link to this event in the Google Calendar Web UI. Read-only.
  • i-cal-uid=consetetur
    • Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.
  • id=stet
    • Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
      • characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
      • the length of the ID must be between 5 and 1024 characters
      • the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
  • kind=accusam
    • Type of the resource ("calendar#event").
  • location=consetetur
    • Geographic location of the event as free-form text. Optional.
  • locked=true
    • Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
  • organizer display-name=nonumy
    • The organizer's name, if available.
  • email=sea
    • The organizer's email address, if available. It must be a valid email address as per RFC5322.
  • id=eos
    • The organizer's Profile ID, if available.

  • self=true

    • Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

  • ..original-start-time date=sed

    • The date, in the format "yyyy-mm-dd", if this is an all-day event.
  • date-time=labore
    • The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

  • time-zone=et

    • The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.

  • ..out-of-office-properties auto-decline-mode=eirmod

    • Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined.

  • decline-message=sed

    • Response message to set if an existing event or new invitation is automatically declined by Calendar.

  • .. private-copy=true

    • If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
  • recurrence=lorem
    • List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
    • Each invocation of this argument appends the given value to the array.
  • recurring-event-id=dolor
    • For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

  • reminders use-default=false

    • Whether the default reminders of the calendar apply to the event.

  • .. sequence=18

    • Sequence number as per iCalendar.
  • source title=magna
    • Title of the source; for example a title of a web page or an email subject.

  • url=invidunt

    • URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

  • ..start date=et

    • The date, in the format "yyyy-mm-dd", if this is an all-day event.
  • date-time=et
    • The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

  • time-zone=dolor

    • The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.

  • .. status=erat

    • Status of the event. Optional. Possible values are:
      • "confirmed" - The event is confirmed. This is the default status.
      • "tentative" - The event is tentatively confirmed.
      • "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:
      • Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
      • All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
  • summary=dolore
    • Title of the event.
  • transparency=vero
    • Whether the event blocks time on the calendar. Optional. Possible values are:
      • "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
      • "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
  • updated=ea
    • Last modification time of the event (as a RFC3339 timestamp). Read-only.
  • visibility=et
    • Visibility of the event. Optional. Possible values are:
      • "default" - Uses the default visibility for events on the calendar. This is the default value.
      • "public" - The event is public and event details are visible to all readers of the calendar.
      • "private" - The event is private and only event attendees may view event details.
      • "confidential" - The event is private. This value is provided for compatibility reasons.

  • working-location-properties.custom-location label=amet.

    • An optional extra label for additional information.

  • ..office-location building-id=eirmod

    • An optional building identifier. This should reference a building ID in the organization's Resources database.
  • desk-id=sanctus
    • An optional desk identifier.
  • floor-id=sed
    • An optional floor identifier.
  • floor-section-id=dolor
    • An optional floor section identifier.

  • label=et

    • The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database.

  • .. type=et

    • Type of the working location. Possible values are:
      • "homeOffice" - The user is working at home.
      • "officeLocation" - The user is working from an office.
      • "customLocation" - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Any other fields are ignored. Required when adding working location properties.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p always-include-email=boolean

    • 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 (i.e. a generated, non-working value will be provided).

  • -p conference-data-version=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.

  • -p max-attendees=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.

  • -p send-notifications=boolean

    • Deprecated. Please use sendUpdates instead.

      Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

  • -p send-updates=string

    • Guests who should receive notifications about the event update (for example, title changes, etc.).

  • -p supports-attachments=boolean

    • Whether API client performing operation supports event attachments. Optional. The default is False.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.