--- title: "POST /calendars/{calendarId}/events" method: POST path: "/calendars/{calendarId}/events" tags: ["events"] --- # POST /calendars/{calendarId}/events `POST /calendars/{calendarId}/events` Creates an event. ## Path parameters - `calendarId` string, required ## Query parameters - `conferenceDataVersion` integer - `eventLabelVersion` integer - `maxAttendees` integer - `sendNotifications` boolean - `sendUpdates` 'all' | 'externalOnly' | 'none' - `supportsAttachments` boolean ## Request body - Event - `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. - `description` string — Description of the event. Can contain HTML. Optional. - `focusTimeProperties` EventFocusTimeProperties - `chatStatus` string — The status to mark the user in Chat and related products. This can be available or doNotDisturb. - `autoDeclineMode` string — 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. - `declineMessage` string — Response message to set if an existing event or new invitation is automatically declined by Calendar. - `reminders` object — Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. - `overrides` EventReminder[] — If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. - `method` string — The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder. - `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. - `useDefault` boolean — Whether the default reminders of the calendar apply to the event. - `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. - `extendedProperties` object — Extended properties of the event. - `private` object — Properties that are private to the copy of the event that appears on this calendar. - `shared` object — Properties that are shared between copies of the event on other attendees' calendars. - `creator` object — The creator of the event. Read-only. - `email` string — The creator's email address, if available. - `displayName` string — The creator's name, if available. - `id` string — The creator's Profile ID, if available. - `self` boolean — Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. - `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. - `email` string — The organizer's email address, if available. It must be a valid email address as per RFC5322. - `displayName` string — The organizer's name, if available. - `id` string — The organizer's Profile ID, if available. - `self` boolean — Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. - `start` EventDateTime - `date` string, date — The date, in the format "yyyy-mm-dd", if this is an all-day event. - `dateTime` string, 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. - `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. - `guestsCanSeeOtherGuests` boolean — Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. - `attachments` EventAttachment[] — File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, - `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. - `title` string — Attachment title. - `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. - `mimeType` string — Internet media type (MIME type) of the attachment. - `iconLink` string — URL link to the attachment's icon. This field can only be modified for custom third-party attachments. - `birthdayProperties` EventBirthdayProperties - `customTypeName` string — Custom type label specified for this event. This is populated if birthdayProperties.type is set to "custom". Read-only. - `contact` string — Resource name of the contact this birthday event is linked to. This can be used to fetch contact details from People API. Format: "people/c12345". Read-only. - `type` string — Type of birthday or special event. Possible values are: - "anniversary" - An anniversary other than birthday. Always has a contact. - "birthday" - A birthday event. This is the default value. - "custom" - A special date whose label is further specified in the customTypeName field. Always has a contact. - "other" - A special date which does not fall into the other categories, and does not have a custom label. Always has a contact. - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created. - `conferenceData` ConferenceData - `conferenceSolution` ConferenceSolution - `iconUri` string — The user-visible icon for this solution. - `key` 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 (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` string — The user-visible name of this solution. Not localized. - `createRequest` CreateConferenceRequest - `conferenceSolutionKey` 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 (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 - `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. - `status` ConferenceRequestStatus - `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. - `parameters` ConferenceParameters - `addOnParameters` ConferenceParametersAddOnParameters - `parameters` object - `signature` string — 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. - `entryPoints` EntryPoint[] — Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required. - `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. - `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. - `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. - `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: 12345678@altostrat.com - for more: should not be filled Optional. - `entryPointFeatures` string[] — Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. - `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. - `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. - `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. - `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. - `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:12345678@myprovider.com. - for more, http: or https: schema is required. - `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. - `conferenceId` string — 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. - `workingLocationProperties` EventWorkingLocationProperties - `customLocation` object — If present, specifies that the user is working from a custom location. - `label` string — An optional extra label for additional information. - `homeOffice` unknown - `type` string — 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. - `officeLocation` object — If present, specifies that the user is working from an office. - `buildingId` string — An optional building identifier. This should reference a building ID in the organization's Resources database. - `floorSectionId` string — An optional floor section identifier. - `label` string — 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. - `floorId` string — An optional floor identifier. - `deskId` string — An optional desk identifier. - `gadget` object — A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. - `iconLink` string — The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. - `link` string — The gadget's URL. The URL scheme must be HTTPS. Deprecated. - `display` string — 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` integer — The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. - `preferences` object — Preferences. - `title` string — The gadget's title. Deprecated. - `width` integer — The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. - `type` string — The gadget's type. Deprecated. - `hangoutLink` string — An absolute link to the Google Hangout associated with this event. Read-only. - `recurrence` string[] — 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. - `created` string, date-time — Creation time of the event (as a RFC3339 timestamp). Read-only. - `eventLabelId` string — The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. Setting an empty string, or not setting this field at all, will remove the existing label from the event. - `privateCopy` boolean — 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. - `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. Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. - `htmlLink` string — An absolute link to this event in the Google Calendar Web UI. Read-only. - `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. - `summary` string — Title of the event. - `eventType` string — Specific type of the event. This cannot be modified after the event is created. Possible values are: - "birthday" - A special all-day event with an annual recurrence. - "default" - A regular event or not further specified. - "focusTime" - A focus-time event. - "fromGmail" - An event from Gmail. This type of event cannot be created. - "outOfOffice" - An out-of-office event. - "workingLocation" - A working location event. - `guestsCanModify` boolean — Whether attendees other than the organizer can modify the event. Optional. The default is False. - `recurringEventId` string — For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - `updated` string, date-time — Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. - `end` EventDateTime - `date` string, date — The date, in the format "yyyy-mm-dd", if this is an all-day event. - `dateTime` string, 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. - `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. - `etag` string — ETag of the resource. - `attendees` EventAttendee[] — The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. - `displayName` string — The attendee's name, if available. Optional. - `comment` string — The attendee's response comment. Optional. - `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. - `optional` boolean — Whether this is an optional attendee. Optional. The default is False. - `asyncOperation` string — If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. Possible values are: - "inProgress" - The asynchronous operation is in progress. - (not present) - Otherwise. - `additionalGuests` integer — Number of additional guests. Optional. The default is 0. - `id` string — The attendee's Profile ID, if available. - `self` boolean — Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. - `organizer` boolean — Whether the attendee is the organizer of the event. Read-only. The default is False. - `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. - `responseStatus` string — The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation (recommended for new events). - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the "Add invitations to my calendar" setting set to "When I respond to invitation in email" or "Only if the sender is known" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests. - `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. 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. - `location` string — Geographic location of the event as free-form text. Optional. - `outOfOfficeProperties` EventOutOfOfficeProperties - `autoDeclineMode` string — 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. - `declineMessage` string — Response message to set if an existing event or new invitation is automatically declined by Calendar. - `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. - `guestsCanInviteOthers` boolean — Whether attendees other than the organizer can invite others to the event. Optional. The default is True. - `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. - `sequence` integer — Sequence number as per iCalendar. - `kind` string — Type of the resource ("calendar#event"). - `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. - `title` string — Title of the source; for example a title of a web page or an email subject. - `url` string — URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. - `originalStartTime` EventDateTime - `date` string, date — The date, in the format "yyyy-mm-dd", if this is an all-day event. - `dateTime` string, 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. - `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. - `anyoneCanAddSelf` boolean — Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. - `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. - `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. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/calendar.md) · [All operations](https://skmtc.net/google/apis/calendar/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/calendar/revisions/8a9c54b56c55/schema)