calendarId STRING Required

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

text STRING Required

The text describing the event to be created

sendNotifications BOOLEAN

Deprecated. Please use sendUpdates instead.

Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false

sendUpdates ENUMERATION

Guests who should receive notifications about the creation of the new event

anyoneCanAddSelf BOOLEAN

Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False

attachments[] OBJECT

attachments[].fileId STRING

ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API

attachments[].fileUrl STRING

URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment

attachments[].iconLink STRING

URL link to the attachment's icon. Read-only

attachments[].mimeType STRING

Internet media type (MIME type) of the attachment

attachments[].title STRING

Attachment title

attendees[] OBJECT

attendees[].additionalGuests INTEGER

Number of additional guests. Optional. The default is 0

attendees[].comment STRING

The attendee's response comment. Optional

attendees[].displayName STRING

The attendee's name, if available. Optional

attendees[].email STRING

The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee

attendees[].id STRING

The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

attendees[].optional BOOLEAN

Whether this is an optional attendee. Optional. The default is False

attendees[].organizer BOOLEAN

Whether the attendee is the organizer of the event. Read-only. The default is False

attendees[].resource BOOLEAN

Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False

attendees[].responseStatus STRING

The attendee's response status. Possible values are:

• "needsAction" - The attendee has not responded to the invitation.
• "declined" - The attendee has declined the invitation.
• "tentative" - The attendee has tentatively accepted the invitation.
• "accepted" - The attendee has accepted the invitation.

attendees[].self BOOLEAN

Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False

attendeesOmitted BOOLEAN

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

colorId STRING

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

conferenceData OBJECT

conferenceData.conferenceId STRING

The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types:

• "eventHangout": unset.
• "eventNamedHangout": the name of the Hangout.
• "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.

conferenceData.conferenceSolution OBJECT

conferenceData.conferenceSolution.iconUri STRING

The user-visible icon for this solution

conferenceData.conferenceSolution.key OBJECT

conferenceData.conferenceSolution.key.type STRING

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 (http://hangouts.google.com)
• "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
• "hangoutsMeet" for Hangouts Meet (http://meet.google.com)

conferenceData.conferenceSolution.name STRING

The user-visible name of this solution. Not localized

conferenceData.createRequest OBJECT

conferenceData.createRequest.conferenceSolutionKey OBJECT

conferenceData.createRequest.conferenceSolutionKey.type STRING

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 (http://hangouts.google.com)
• "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
• "hangoutsMeet" for Hangouts Meet (http://meet.google.com)

conferenceData.createRequest.requestId STRING

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

conferenceData.createRequest.status OBJECT

conferenceData.createRequest.status.statusCode STRING

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.

conferenceData.entryPoints[] OBJECT

conferenceData.entryPoints[].accessCode STRING

The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional

conferenceData.entryPoints[].entryPointFeatures[] STRING

conferenceData.entryPoints[].entryPointType STRING

The type of the conference entry point. Possible values are:

• "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
• "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
• "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
• "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.

conferenceData.entryPoints[].label STRING

The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples:

• for video: meet.google.com/aaa-bbbb-ccc
• for phone: +1 123 268 2601
• for sip: [email protected]
• for more: should not be filled
  Optional.

conferenceData.entryPoints[].meetingCode STRING

The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional

conferenceData.entryPoints[].passcode STRING

The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed

conferenceData.entryPoints[].password STRING

The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional

conferenceData.entryPoints[].pin STRING

The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional

conferenceData.entryPoints[].regionCode STRING

The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE

conferenceData.entryPoints[].uri STRING

The URI of the entry point. The maximum length is 1300 characters. Format:

• for video, http: or https: schema is required.
• for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
• for sip, sip: schema is required, e.g., sip:[email protected].
• for more, http: or https: schema is required.

conferenceData.notes STRING

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

conferenceData.parameters OBJECT

conferenceData.parameters.addOnParameters OBJECT

conferenceData.parameters.addOnParameters.parameters OBJECT

conferenceData.parameters.addOnParameters.parameters.customKey.value STRING

conferenceData.signature STRING

The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request

created DATE_TIME

Creation time of the event (as a RFC3339 timestamp). Read-only

creator OBJECT

The creator of the event. Read-only

creator.displayName STRING

The creator's name, if available

creator.email STRING

The creator's email address, if available

creator.id STRING

The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

creator.self BOOLEAN

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

description STRING

Description of the event. Optional

end OBJECT

end.date DATE

The date, in the format "yyyy-mm-dd", if this is an all-day event

end.dateTime DATE_TIME

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

end.timeZone STRING

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

endTimeUnspecified BOOLEAN

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 STRING

ETag of the resource

extendedProperties OBJECT

Extended properties of the event

extendedProperties.private OBJECT

Properties that are private to the copy of the event that appears on this calendar

extendedProperties.private.customKey.value STRING

Properties that are private to the copy of the event that appears on this calendar

extendedProperties.shared OBJECT

Properties that are shared between copies of the event on other attendees' calendars

extendedProperties.shared.customKey.value STRING

Properties that are shared between copies of the event on other attendees' calendars

gadget OBJECT

A gadget that extends this event

gadget.display STRING

The gadget's display mode. Optional. 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.

gadget.height INTEGER

The gadget's height in pixels. The height must be an integer greater than 0. Optional

gadget.iconLink STRING

The gadget's icon URL. The URL scheme must be HTTPS

gadget.link STRING

The gadget's URL. The URL scheme must be HTTPS

gadget.preferences OBJECT

Preferences

gadget.preferences.customKey.value STRING

Preferences

gadget.title STRING

The gadget's title

gadget.type STRING

The gadget's type

gadget.width INTEGER

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

guestsCanInviteOthers BOOLEAN

Whether attendees other than the organizer can invite others to the event. Optional. The default is True

guestsCanModify BOOLEAN

Whether attendees other than the organizer can modify the event. Optional. The default is False

guestsCanSeeOtherGuests BOOLEAN

Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True

hangoutLink STRING

An absolute link to the Google+ hangout associated with this event. Read-only

htmlLink STRING

An absolute link to this event in the Google Calendar Web UI. Read-only

iCalUID STRING

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

id STRING

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 STRING

Type of the resource ("calendar#event")

location STRING

Geographic location of the event as free-form text. Optional

locked BOOLEAN

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 OBJECT

The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event

organizer.displayName STRING

The organizer's name, if available

organizer.email STRING

The organizer's email address, if available. It must be a valid email address as per RFC5322

organizer.id STRING

The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

organizer.self BOOLEAN

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

originalStartTime OBJECT

originalStartTime.date DATE

The date, in the format "yyyy-mm-dd", if this is an all-day event

originalStartTime.dateTime DATE_TIME

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

originalStartTime.timeZone STRING

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

privateCopy BOOLEAN

Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False

recurrence[] STRING

recurringEventId STRING

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable

reminders OBJECT

Information about the event's reminders for the authenticated user

reminders.overrides[] OBJECT

reminders.overrides[].method STRING

The method used by this reminder. Possible values are:

• "email" - Reminders are sent via email.
• "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
• "popup" - Reminders are sent via a UI popup.
  Required when adding a reminder.

reminders.overrides[].minutes INTEGER

Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder

reminders.useDefault BOOLEAN

Whether the default reminders of the calendar apply to the event

sequence INTEGER

Sequence number as per iCalendar

source OBJECT

Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event

source.title STRING

Title of the source; for example a title of a web page or an email subject

source.url STRING

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

start OBJECT

start.date DATE

The date, in the format "yyyy-mm-dd", if this is an all-day event

start.dateTime DATE_TIME

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

start.timeZone STRING

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 STRING

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 STRING

Title of the event

transparency STRING

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 DATE_TIME

Last modification time of the event (as a RFC3339 timestamp). Read-only

visibility STRING

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.