Version:
Only show these results:

v3 Upgrade process overview

If you're an existing customer preparing to upgrade from Nylas v2.x to v3, this page collects information to help you migrate your implementation.

✨ Want a version of this guide tailored to your project? Check out Nylas Migration Station!

General upgrade process

To start your upgrade, create a Dashboard v3 account if you haven't already.

Next, create a development application and work on upgrading your project code to use the Nylas v3 APIs.

When you have upgraded your project and tested to confirm that all features and functionality are working as expected, you can begin migrating users to the v3 project.

You can do this either using the Migration APIs, or by having users re-authenticate using the v3 project. In most cases Microsoft users must reauthenticate.

In general, you should familiarize yourself with the high-level changes below, then read the sections in the following order:

High-level change summaries

You can refer to the following pages for a high-level summary of the changes in Nylas v3:

Authentication upgrade guides

Your first stop should be the authentication sections, because these methods have changed completely in Nylas v3:

Provider guides

These guides cover some of the set up and changes for each of Google, Microsoft Graph, and IMAP provider connectors. You should also review the v3 Scopes reference if you haven't already, as you'll need to request scopes for each provider auth app.

Webhooks upgrade guides

Per-API upgrade guides

You can read a version of each of these for the top-level APIs:

SDK upgrade guides