public-beta-v3

Email in Nylas API v3

The Nylas API v3 is in public beta. It might contain bugs, and might change before it is generally available. See the v3 Beta documentation for more information.

This page lists and explains the changes to Messages, Drafts, and related APIs between Nylas v2.7 and v3.

Messages and Drafts changes

All Messages and Drafts now need a grant_id or equivalent access method (email address, me, and so on).
You can now send Drafts.
You can schedule send time for a Message (and edit and delete scheduled send times).
Labels and Folders have been consolidated into Folders.
Files are now Attachments.
You can now delete Messages.
New webhooks have been added: message.send_success and message.send_failed for tracking scheduled-send results, and message.bounce_detected to check for bounces.
Added schedule_id to POST calls.
Added send_at to POST calls.
Added use_draft to POST calls.
The folder property is now folders in all Messages calls.
Deprecated the labels property in all Messages calls and replaced it with folders.
Deprecated the not_in query parameter in GET calls.
Deprecated the filename query parameter in GET calls.
Deprecated the events property in GET calls.
Deprecated the cids property in GET calls.

Folders and Labels endpoint changes

All Labels endpoints have been replaced by Folders endpoints.
Added system_folder for Google in all Folders calls.
Added total_count in POST and PUT calls.
Added unread_count in GET calls.

Send endpoint changes

Added an attachments property to POST calls.
Added send_at to POST calls for scheduled Messages.
Added is_draft to POST calls for scheduled send.

Files (Attachments) changes

The Files endpoints have been replaced by Attachments endpoints.
POST File upload has been deprecated.
GET /files has been deprecated.
DELETE /files/<file_id> has been deprecated.