Event Fields

Event Properties

Property	Type	Description	iOS	Android
id*	String	Unique id for the calendar event.	✓	✓
calendarId**	String	Unique id for the calendar where the event will be saved. Defaults to the device's default calendar.	✓	✓
title	String	The title for the calendar event.	✓	✓
startDate	Date	The start date of the calendar event in ISO format.	✓	✓
endDate	Date	The end date of the calendar event in ISO format.	✓	✓
allDay	Bool	Indicates whether the event is an all-day event.	✓	✓
recurrence	String	The simple recurrence frequency of the calendar event daily, weekly, monthly, yearly or none.	✓	✓
recurrenceRule **	Object	The events recurrence settings.	✓	✓
occurrenceDate*	Date	The original occurrence date of an event if it is part of a recurring series.	✓
isDetached	Bool	Indicates whether an event is a detached instance of a repeating event.	✓
url	String	The url associated with the calendar event.	✓	✓
location	String	The location associated with the calendar event.	✓	✓
notes	String	The notes associated with the calendar event.	✓
description	String	The description associated with the calendar event.		✓
alarms	Array	The alarms associated with the calendar event, as an array of alarm objects.	✓	✓
calendar*	Object	The calendar containing the event.	✓	✓

* Read only, ** Write only

Recurrence Rule properties:

Property	Type	Description	iOS	Android
frequency	String	Event recurring frequency daily, weekly, monthly, yearly	✓	✓
endDate	Date	Event recurring end date. This overrides occurrence	✓	✓
occurrence	Number	Number of event occurrences.	✓	✓
interval	Number	The interval between events of this recurrence.	✓	✓

* Read only, ** Write only

Options:

Property	Type	Description	iOS	Android
exceptionDate	Date	The start date of a recurring event's exception instance. Used for updating single event in a recurring series		✓
futureEvents	Bool	If true the update will span all recurring events. If false it only update the single instance.	✓

Alarm options:

Property	Type	Description	iOS	Android
date	Date or Number	If a Date is given, an alarm will be set with an absolute date. If a Number is given, an alarm will be set with a relative offset (in minutes) from the start date.	✓	✓
structuredLocation	Object	The location to trigger an alarm.	✓

Alarm structuredLocation properties:

Property	Type	Description	iOS	Android
title	String	The title of the location.	✓
proximity	String	A value indicating how a location-based alarm is triggered. Possible values: enter, leave, none.	✓
radius	Number	A minimum distance from the core location that would trigger the calendar event's alarm.	✓
coords	Object	The geolocation coordinates, as an object with latitude and longitude properties	✓