Creates an event. Try it now or see an example.
Request
HTTP request
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events
Parameters
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.
|
Optional query parameters | ||
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 |
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 you set the value to false . The default is false .
|
sendUpdates |
string |
Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false .
Acceptable values are:
|
supportsAttachments |
boolean |
Whether API client performing operation supports event attachments. Optional. The default is False. |
Authorization
This request requires authorization with at least one of the following scopes:
Scope |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
For more information, see the authentication and authorization page.
Request body
In the request body, supply an Events resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
Required Properties | |||
end |
nested object |
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. | |
start |
nested object |
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. | |
Optional Properties | |||
anyoneCanAddSelf |
boolean |
Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. | writable |
attachments[].fileUrl |
string |
URL link to the attachment. For adding Google Drive file attachments use the same format as in Required when adding an attachment. |
writable |
attendees[] |
list |
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. | writable |
attendees[].additionalGuests |
integer |
Number of additional guests. Optional. The default is 0. | writable |
attendees[].comment |
string |
The attendee's response comment. Optional. | writable |
attendees[].displayName |
string |
The attendee's name, if available. Optional. | writable |
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. |
writable |
attendees[].optional |
boolean |
Whether this is an optional attendee. Optional. The default is False. | writable |
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. | writable |
attendees[].responseStatus |
string |
The attendee's response status. Possible values are:
|
writable |
birthdayProperties |
nested object |
Birthday or special event data. Used if eventType is "birthday" . Immutable. |
writable |
birthdayProperties.type |
string |
Type of birthday or special event. Possible values are:
"birthday" . The type cannot be changed after the event is created. |
writable |
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. |
writable |
conferenceData |
nested object |
The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. |
writable |
description |
string |
Description of the event. Can contain HTML. Optional. | writable |
end.date |
date |
The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
end.dateTime |
datetime |
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 . |
writable |
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. | writable |
eventType |
string |
Specific type of the event. This cannot be modified after the event is created. Possible values are:
|
writable |
extendedProperties.private |
object |
Properties that are private to the copy of the event that appears on this calendar. | writable |
extendedProperties.shared |
object |
Properties that are shared between copies of the event on other attendees' calendars. | writable |
focusTimeProperties |
nested object |
Focus Time event data. Used if eventType is focusTime . |
writable |
gadget.display |
string |
The gadget's display mode. Deprecated. Possible values are:
|
writable |
gadget.height |
integer |
The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. | writable |
gadget.iconLink |
string |
The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. | writable |
gadget.link |
string |
The gadget's URL. The URL scheme must be HTTPS. Deprecated. | writable |
gadget.preferences |
object |
Preferences. | writable |
gadget.title |
string |
The gadget's title. Deprecated. | writable |
gadget.type |
string |
The gadget's type. Deprecated. | writable |
gadget.width |
integer |
The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. | writable |
guestsCanInviteOthers |
boolean |
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. | writable |
guestsCanModify |
boolean |
Whether attendees other than the organizer can modify the event. Optional. The default is False. | writable |
guestsCanSeeOtherGuests |
boolean |
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. | writable |
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:
If you do not specify an ID, it will be automatically generated by the server. Note that the |
writable |
location |
string |
Geographic location of the event as free-form text. Optional. | writable |
originalStartTime.date |
date |
The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
originalStartTime.dateTime |
datetime |
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 . |
writable |
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. | writable |
outOfOfficeProperties |
nested object |
Out of office event data. Used if eventType is outOfOffice . |
writable |
recurrence[] |
list |
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. |
writable |
reminders.overrides[] |
list |
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. | writable |
reminders.overrides[].method |
string |
The method used by this reminder. Possible values are:
Required when adding a reminder. |
writable |
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. |
writable |
reminders.useDefault |
boolean |
Whether the default reminders of the calendar apply to the event. | writable |
sequence |
integer |
Sequence number as per iCalendar. | writable |
source.title |
string |
Title of the source; for example a title of a web page or an email subject. | writable |
source.url |
string |
URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. | writable |
start.date |
date |
The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
start.dateTime |
datetime |
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 . |
writable |
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. | writable |
status |
string |
Status of the event. Optional. Possible values are:
|
writable |
summary |
string |
Title of the event. | writable |
transparency |
string |
Whether the event blocks time on the calendar. Optional. Possible values are:
|
writable |
visibility |
string |
Visibility of the event. Optional. Possible values are:
|
writable |
workingLocationProperties |
nested object |
Working location event data. | writable |
workingLocationProperties.customLocation |
object |
If present, specifies that the user is working from a custom location. | writable |
workingLocationProperties.customLocation.label |
string |
An optional extra label for additional information. | writable |
workingLocationProperties.homeOffice |
any value |
If present, specifies that the user is working at home. | writable |
workingLocationProperties.officeLocation |
object |
If present, specifies that the user is working from an office. | writable |
workingLocationProperties.officeLocation.buildingId |
string |
An optional building identifier. This should reference a building ID in the organization's Resources database. | writable |
workingLocationProperties.officeLocation.deskId |
string |
An optional desk identifier. | writable |
workingLocationProperties.officeLocation.floorId |
string |
An optional floor identifier. | writable |
workingLocationProperties.officeLocation.floorSectionId |
string |
An optional floor section identifier. | writable |
workingLocationProperties.officeLocation.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. | writable |
workingLocationProperties.type |
string |
Type of the working location. Possible values are:
Required when adding working location properties. |
writable |
Response
If successful, this method returns an Events resource in the response body.
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library.
// Refer to the Java quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/java // Change the scope to CalendarScopes.CALENDAR and delete any stored // credentials. Event event = new Event() .setSummary("Google I/O 2015") .setLocation("800 Howard St., San Francisco, CA 94103") .setDescription("A chance to hear more about Google's developer products."); DateTime startDateTime = new DateTime("2015-05-28T09:00:00-07:00"); EventDateTime start = new EventDateTime() .setDateTime(startDateTime) .setTimeZone("America/Los_Angeles"); event.setStart(start); DateTime endDateTime = new DateTime("2015-05-28T17:00:00-07:00"); EventDateTime end = new EventDateTime() .setDateTime(endDateTime) .setTimeZone("America/Los_Angeles"); event.setEnd(end); String[] recurrence = new String[] {"RRULE:FREQ=DAILY;COUNT=2"}; event.setRecurrence(Arrays.asList(recurrence)); EventAttendee[] attendees = new EventAttendee[] { new EventAttendee().setEmail("lpage@example.com"), new EventAttendee().setEmail("sbrin@example.com"), }; event.setAttendees(Arrays.asList(attendees)); EventReminder[] reminderOverrides = new EventReminder[] { new EventReminder().setMethod("email").setMinutes(24 * 60), new EventReminder().setMethod("popup").setMinutes(10), }; Event.Reminders reminders = new Event.Reminders() .setUseDefault(false) .setOverrides(Arrays.asList(reminderOverrides)); event.setReminders(reminders); String calendarId = "primary"; event = service.events().insert(calendarId, event).execute(); System.out.printf("Event created: %s\n", event.getHtmlLink());
Python
Uses the Python client library.
# Refer to the Python quickstart on how to setup the environment: # https://developers.google.com/calendar/quickstart/python # Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any # stored credentials. event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'}, ], 'reminders': { 'useDefault': False, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10}, ], }, } event = service.events().insert(calendarId='primary', body=event).execute() print 'Event created: %s' % (event.get('htmlLink'))
PHP
Uses the PHP client library.
// Refer to the PHP quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/php // Change the scope to Google_Service_Calendar::CALENDAR and delete any stored // credentials. $event = new Google_Service_Calendar_Event(array( 'summary' => 'Google I/O 2015', 'location' => '800 Howard St., San Francisco, CA 94103', 'description' => 'A chance to hear more about Google\'s developer products.', 'start' => array( 'dateTime' => '2015-05-28T09:00:00-07:00', 'timeZone' => 'America/Los_Angeles', ), 'end' => array( 'dateTime' => '2015-05-28T17:00:00-07:00', 'timeZone' => 'America/Los_Angeles', ), 'recurrence' => array( 'RRULE:FREQ=DAILY;COUNT=2' ), 'attendees' => array( array('email' => 'lpage@example.com'), array('email' => 'sbrin@example.com'), ), 'reminders' => array( 'useDefault' => FALSE, 'overrides' => array( array('method' => 'email', 'minutes' => 24 * 60), array('method' => 'popup', 'minutes' => 10), ), ), )); $calendarId = 'primary'; $event = $service->events->insert($calendarId, $event); printf('Event created: %s\n', $event->htmlLink);
Ruby
Uses the Ruby client library.
event = Google::Apis::CalendarV3::Event.new( summary: 'Google I/O 2015', location: '800 Howard St., San Francisco, CA 94103', description: 'A chance to hear more about Google\'s developer products.', start: Google::Apis::CalendarV3::EventDateTime.new( date_time: '2015-05-28T09:00:00-07:00', time_zone: 'America/Los_Angeles' ), end: Google::Apis::CalendarV3::EventDateTime.new( date_time: '2015-05-28T17:00:00-07:00', time_zone: 'America/Los_Angeles' ), recurrence: [ 'RRULE:FREQ=DAILY;COUNT=2' ], attendees: [ Google::Apis::CalendarV3::EventAttendee.new( email: 'lpage@example.com' ), Google::Apis::CalendarV3::EventAttendee.new( email: 'sbrin@example.com' ) ], reminders: Google::Apis::CalendarV3::Event::Reminders.new( use_default: false, overrides: [ Google::Apis::CalendarV3::EventReminder.new( reminder_method: 'email', minutes: 24 * 60 ), Google::Apis::CalendarV3::EventReminder.new( reminder_method: 'popup', minutes: 10 ) ] ) ) result = client.insert_event('primary', event) puts "Event created: #{result.html_link}"
.NET
Uses the .NET client library.
// Refer to the .NET quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/dotnet // Change the scope to CalendarService.Scope.Calendar and delete any stored // credentials. Event newEvent = new Event() { Summary = "Google I/O 2015", Location = "800 Howard St., San Francisco, CA 94103", Description = "A chance to hear more about Google's developer products.", Start = new EventDateTime() { DateTime = DateTime.Parse("2015-05-28T09:00:00-07:00"), TimeZone = "America/Los_Angeles", }, End = new EventDateTime() { DateTime = DateTime.Parse("2015-05-28T17:00:00-07:00"), TimeZone = "America/Los_Angeles", }, Recurrence = new String[] { "RRULE:FREQ=DAILY;COUNT=2" }, Attendees = new EventAttendee[] { new EventAttendee() { Email = "lpage@example.com" }, new EventAttendee() { Email = "sbrin@example.com" }, }, Reminders = new Event.RemindersData() { UseDefault = false, Overrides = new EventReminder[] { new EventReminder() { Method = "email", Minutes = 24 * 60 }, new EventReminder() { Method = "sms", Minutes = 10 }, } } }; String calendarId = "primary"; EventsResource.InsertRequest request = service.Events.Insert(newEvent, calendarId); Event createdEvent = request.Execute(); Console.WriteLine("Event created: {0}", createdEvent.HtmlLink);
Go
Uses the Go client library.
// Refer to the Go quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/go // Change the scope to calendar.CalendarScope and delete any stored credentials. event := &calendar.Event{ Summary: "Google I/O 2015", Location: "800 Howard St., San Francisco, CA 94103", Description: "A chance to hear more about Google's developer products.", Start: &calendar.EventDateTime{ DateTime: "2015-05-28T09:00:00-07:00", TimeZone: "America/Los_Angeles", }, End: &calendar.EventDateTime{ DateTime: "2015-05-28T17:00:00-07:00", TimeZone: "America/Los_Angeles", }, Recurrence: []string{"RRULE:FREQ=DAILY;COUNT=2"}, Attendees: []*calendar.EventAttendee{ &calendar.EventAttendee{Email:"lpage@example.com"}, &calendar.EventAttendee{Email:"sbrin@example.com"}, }, } calendarId := "primary" event, err = srv.Events.Insert(calendarId, event).Do() if err != nil { log.Fatalf("Unable to create event. %v\n", err) } fmt.Printf("Event created: %s\n", event.HtmlLink)
JavaScript
Uses the JavaScript client library.
// Refer to the JavaScript quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/js // Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any // stored credentials. var event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles' }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles' }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'} ], 'reminders': { 'useDefault': false, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10} ] } }; var request = gapi.client.calendar.events.insert({ 'calendarId': 'primary', 'resource': event }); request.execute(function(event) { appendPre('Event created: ' + event.htmlLink); });
Node.js
Uses the Node.js client library.
// Refer to the Node.js quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/node // Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any // stored credentials. var event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'}, ], 'reminders': { 'useDefault': false, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10}, ], }, }; calendar.events.insert({ auth: auth, calendarId: 'primary', resource: event, }, function(err, event) { if (err) { console.log('There was an error contacting the Calendar service: ' + err); return; } console.log('Event created: %s', event.htmlLink); });
Try it!
Use the APIs Explorer below to call this method on live data and see the response.