Calendars and Events in Nylas API v3
This page lists and explains the changes to Calendar and Events APIs between Nylas v2.7 and v3.
The API v3 Beta includes the same basic ability to create, read, update, and delete both Events and Calendars (which contain Events). It also includes the new ability to list all Events and Calendars for a specific account, and the new Event RSVP endpoint allows users to set participant statuses for a given Event.
By default, Events are no longer returned in any particular order. You can include the
order_by=start query parameter to order returned Events by start time. This will make your queries match the API v2.7 behavior.
calendar_id is now a required query parameter for most
/events endpoints. This means that you can no longer list all Events from all Calendars, and you must be able to identify which Calendar an Event is associated with in order to retrieve, update, or delete it (you can set the
calendar_id to the user's email address, or set it to
default to select the default or main Calendar for the user on the service provider).
The requirements for Event start and end times have also been changed. The
ends_after parameters have been simplified to only two variables:
start is equivalent to
end is equivalent to
starts_before. When you use either in a query, an Event is returned if any part of it occurs between the
The timezone format for recurring events has been updated as well. In v3, timezone information uses an array of
EXDATE strings. With this change,
TZID are no longer supported. The timezone is now inherited from the
when object's timezone.
DTEND are also no longer supported; instead, use the start and end times set in the
when object. For more information, see RFC-5545.
Finally, round-robin has been updated. It now uses the value of the Nylas
key5 metadata to indicate Events to consider when calculating the next available time amongst group members.
is_owned_by_userproperty, available on all Calendar calls.
hex_colorCalendar property, available for Microsoft and Google calendars on all calls.
- Added access to shared calendars using the
GETendpoint, for Microsoft only.
The following properties are new:
calendar_idis now required on all Events calls.
order_byquery parameter in
capacityproperty in all Events calls.
The following properties have been deprecated:
event_idquery parameter in
participants query parameterin
customer_event_idquery parameter and property in all calls.
owner property isin
The following properties have been changed in v3:
- The new
endreplace all date bracketing query parameters (for example,
- Events are now unordered, unless you apply the
order_byquery parameter in
- Dates within
RRULEno longer need
Zat the end in