Sign in
App migration

Import v2 app settings to linked v3 app

Import the settings from a v2 Nylas application to its linked v3 application. Before you use this endpoint, make sure you link a v2 application to a v3 application.

This endpoint imports the following v2 settings, and sets them to the corresponding v3 application settings:

  • Your website URL.
  • Your icon URL (used to customize the Hosted OAuth page).
  • Redirect URIs for OAuth.
  • Integrations and their settings.
    • Nylas migrates Google integrations to equivalent v3 connectors.
    • If you have v2 Microsoft integrations, you should create a new Azure auth app and update the connector settings. For detailed instructions, see Migrating Microsoft accounts.
    • Nylas migrates IMAP, iCloud, and EWS integrations to v3 connectors with auto-generated default values.

Nylas automatically detects your application ID from the API key and finds its linked v2 application to begin the import process.

This endpoint is rate limited to 20 requests per second, per Nylas application ID.

post/v3/migration-tools/import-v2-app

Response

Immedieately returns a list of two Jobs, Snapshot and BatchClone. Those Jobs continue to synchronously run in the background.

request_idstring

The request ID.

datastring

Info message about success.

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": "V2 Application imported successfully to v3 Application: app settings, Connectors, redirect URIs, etc."
}

Changes