Nylas Docs

API Docs
Developer Guide

Try it Free ↗️
{{user.name}}Log In

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

v1.0
v2.0.1stable

HomeDeveloper GuideAPI DocsReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Developer Guide

Search results for "{{ search.query }}"

No results found for "{{search.query}}".

Documentation
{{result._method}}Reference
Changelog
Discussions
Page

View All Results

Developer Guide

Getting Started
Quickstart Guides
Tutorials
Authentication
Example Code
Nylas Support
Billing

Provider Specific Guides

Microsoft
Yahoo
- Common Yahoo Authentication Issues
IMAP
- Inconsistent UIDVALIDITY value
- Connecting to iCloud Accounts
Google

Troubleshooting

Getting Raw Message Contents
Re-enabling stopped accounts
Sending Failures
Authentication Failure Messages
Sent mail is not syncing
I've found a Nylas link that directs to spam, what should I do?

Best Practices

Best practices for improving deliverability
Rate limits
Sync Strategies

Dashboard

Sync Statuses

Other

How to view open support tickets for your organization
Sync engine FAQs
General Data Protection Regulation (GDPR)
Postman + Nylas
Ethics Reporting
What is nyl.as?
File Attachment Media Types

Archive

Native Authentication Setup Guide

Scheduler

Nylas Scheduler
Schedule Editor Setup
Creating and Scheduling Meetings
Whitelabeling Guide
Scheduler Webhooks

Support

Introduction

The Nylas APIs

Authentication

Introduction
Hosted Authentication
Native Authentication
- post/connect/authorize
- post/connect/token

Accounts

Accounts
- get/account
- Single Account Sync States
Account Management
Configuration Problems

Threads

Introduction
get/threads
get/threads/{id}
put/threads/{id}

Messages

Introduction
get/messages
get/messages/{id}
put/messages/{id}
getRaw message contents

Folders

Introduction
get/folders
get/folders/{id}
post/folders
put/folders/{id}
delete/folders/{id}

Labels

Introduction
get/labels
get/labels/{id}
post/labels
put/labels/{id}
delete/labels/{id}

Drafts [beta]

Introduction
get/drafts
get/drafts/{id}
post/drafts
put/drafts/{id}
delete/drafts/{id}

Sending

Introduction
postSending drafts
postSending directly
postSending raw MIME

Files

Introduction
get/files
get/files/{id}
get/files/{id}/download
post/files
delete/files/{id}

Calendars

Introduction
get/calendars
get/calendars/{id}

Events

Introduction
get/events
get/events/{id}
post/events
put/events/{id}
delete/events/{id}
Event Subobjects
postRSVPing to invitations
Limitations

Contacts

Introduction
get/contacts
get/contacts/{id}
post/contacts
put/contacts/{id}
delete/contacts/{id}
get/contacts/{id}/picture
get/contacts/groups
Limitations

Search

Search Overview
getSearch Messages
getSearch Threads

Webhooks

Webhooks Overview
Creating a Webhook
Receiving Notifications
get/webhooks
post/webhooks
get/webhooks/{id}
put/webhooks/{id}
delete/webhooks/{id}

Deltas

Introduction
postObtaining a Delta Cursor
getRequesting a set of deltas
getLong-polling Delta updates
getStreaming Delta updates

Message Tracking

Message Tracking Overview
Understanding Tracking Notifications

Utilities

Filters
Pagination
Views

Other

Rate limiting
Errors
API Versioning
Transition to v2.0
Supported Providers
API Changelog