calendar.events.insert
Creates a Google Calendar event from a JSON Event object, including time, attendees, and reminders. Use it to add new events and optionally send guest notifications.
Instructions
Creates an event [HTTP POST] — creates or triggers a change; 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, instances, list, move, patch, 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. | |
| 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] Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. Values: `all` = Notifications are sent to all guests.; `externalOnly` = Notifications are sent to non-Google Calendar guests only.; `none` = No notifications are sent. Warning: Using the value none can have significant adverse effects, including events not syncing to external calendars or events being lost altogether for some users. 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 creation of the new event. Note that some emails might still be sent even if | |
| 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 |