Nylas Docs

The Nylas Developer Hub

Welcome to the Nylas developer hub. You'll find comprehensive guides and documentation to help you start working with Nylas as quickly as possible, as well as support if you get stuck. Let's jump right in!

Developer Guide

Data Residency

Multi-region support for storing user data

Nylas's data residency offering enables you to comply with legal requirements related to storing PII in different geographic regions around the world. As your data subprocessor, Nylas provides the tools and controls necessary to manage and configure where user data is stored. We offer storage in three regions today: the US, Canada, and Europe.

Each region is completely isolated, so data cannot be passed between regions. You must create, configure, and manage separate Nylas Organizations for each region you would like to store customer data in. Your application must be aware of which user a region belongs to so that it queries the appropriate API.

The table below shows the appropriate URLs to manage your Nylas organizations, and what API endpoints to query, for each region.

LocationDashboard URLAPI URL
United States (Oregon)https://dashboard.nylas.comhttps://api.nylas.com
Europe (Ireland)https://ireland-dashboard.nylas.comhttps://ireland.api.nylas.com
Canada (Central)https://canada-dashboard.nylas.comhttps://canada.api.nylas.com

Getting Started with a New Region


Data Center Steps

The steps are the same for all regions.

To start storing customer data in the new region:

  1. Create a new Nylas Organization at the dashboard URL provided above.
  2. Configure your Nylas application(s) in that organization.
  3. Configure your application code to query the API endpoints associated with the regional data center for accounts in that region.

All of these steps are the same as those outlined in our Getting Started guide for any Nylas setup, but there are two key differences:

  • Make sure to use the appropriate Dashboard depending on the user's region. For example, you will not be able to view users stored in the United States from within the Nylas Canada Dashboard, or view users stored in the EU from the United States.
  • Query the appropriate Nylas API depending on the user's region. You won't be able to query api.nylas.com for a user that is stored in Canada, for example. Instead, you must use canada.api.nylas.com.

Any existing accounts and configurations for your organization at https://dashboard.nylas.com, for example, won't exist in the new region. Each region-specific Dashboard and API is running in a completely isolated environment. This means billing estimates in the dashboard will be region-specific as well.

Nylas Scheduler

Scheduler does not support data residency at this time. All data is stored in the United States.

Updated 2 months ago

Data Residency

Multi-region support for storing user data

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.