This page lists the Email API endpoints and notification triggers available in Nylas v3, and shows which scopes they require. For more information about scopes in Nylas v3, see the Authentication scopes documentation.
All scopes must include the fully qualified URI path for the provider. The table shortens the full scope URI for space reasons, so add the prefix for the provider when requesting scopes.
The ☑️ in each column indicates the most restrictive scope you can request for each provider and still use that API. More permissive scopes appear under the minimum option. If you’re already using one of the permissive scopes, you don’t need to add the more restrictive scope.
Email API scopes
|
Endpoint
|
Google Scopes
https://www.googleapis.com/auth/...
|
Microsoft Scopes
https://graph.microsoft.com/...
|
GET /messages
GET /messages/<MESSAGE_ID> | /gmail.readonly ☑️
/gmail.modify
| Mail.Read ☑️
Mail.ReadWrite
Mail.Read.Shared
Mail.ReadWrite.Shared
|
PUT /messages/<MESSAGE_ID>
DELETE /messages/<MESSAGE_ID> | /gmail.modify ☑️
| Mail.ReadWrite ☑️
Mail.ReadWrite.Shared
|
GET /drafts
GET /drafts/<DRAFT_ID> | /gmail.readonly ☑️
/gmail.compose
| Mail.Read ☑️
Mail.ReadWrite
Mail.Read.Shared
Mail.ReadWrite.Shared
|
POST /drafts
PUT /drafts/<DRAFT_ID>
DELETE /drafts/<DRAFT_ID> | /gmail.compose ☑️
| Mail.ReadWrite ☑️
Mail.ReadWrite.Shared
|
POST /messages/smart-compose
POST /messages/<MESSAGE_ID>/smart-compose | /gmail.readonly ☑️
/gmail.modify
| Mail.Read ☑️
Mail.ReadWrite
Mail.ReadWrite.Shared
Mail.Read.Shared
|
PUT /messages/clean | /gmail.readonly ☑️
| Mail.Read ☑️
|
POST /messages/send
POST /events/<EVENT_ID>/send-rsvp | /gmail.send ☑️
/gmail.compose
/gmail.modify
| Mail.ReadWrite and Mail.Send ☑️
Mail.ReadWrite.Shared and Mail.Send
|
POST /messages/send (using draft) | /gmail.compose ☑️
/gmail.modify
| Mail.ReadWrite and Mail.Send ☑️
Mail.ReadWrite.Shared and Mail.Send
|
GET /folders
GET /folders/<FOLDER_ID> | /gmail.labels ☑️
/gmail.modify
| Mail.Read ☑️
Mail.ReadWrite
Mail.ReadWrite.Shared
Mail.Read.Shared
|
POST /folders
PUT /folders/<FOLDER_ID>
DELETE /folders/<FOLDER_ID> | /gmail.labels ☑️
/gmail.modify
| Mail.ReadWrite ☑️
Mail.ReadWrite.Shared
|
GET /attachments/<ATTACHMENT_ID> | /gmail.readonly ☑️
/gmail.modify
| Mail.Read ☑️
Mail.ReadWrite
Mail.ReadWrite.Shared
Mail.Read.Shared
|
GET /messages/schedules
GET /messages/schedules/<SCHEDULE_ID>
DELETE /messages/schedules/<SCHEDULE_ID> | No scopes are required because scheduled email messages are stored with Nylas. To send scheduled email messages, you need gmail.send for Google, or Mail.ReadWrite and Mail.Send for Microsoft. |
Email API scopes for Yahoo OAuth
If you use Yahoo OAuth authentication to connect to Yahoo users’ email inboxes, include the following scopes in your Yahoo provider auth app.
📝 Note: All Email notifications require the Yahoo email and mail-r scopes.
| Endpoint | Yahoo scopes |
|---|
GET /messages
GET /messages/<MESSAGE_ID>
GET /drafts
GET /drafts/<DRAFT_ID>
GET /folders
GET /folders/<FOLDER_ID>
GET /attachments/<ATTACHMENT_ID>
|
email
mail-r
|
PUT /messages/<MESSAGE_ID>
DELETE /messages/<MESSAGE_ID>
POST /drafts
PUT /drafts/<DRAFT_ID>
DELETE /drafts/<DRAFT_ID>
POST /messages/smart-compose
POST /messages/<MESSAGE_ID>/smart-compose
POST /messages/send
POST /messages/send (using draft)
POST /folders
PUT /folders/<FOLDER_ID>
DELETE /folders/<FOLDER_ID>
|
email
mail-r
mail-w
|
Email notification scopes
| Notification trigger | Google Scopes
https://www.googleapis.com/auth/... | Microsoft Scopes
https://graph.microsoft.com/... |
message.send_success
message.send_failed
| /gmail.send ☑️
| Mail.ReadWrite and Mail.Send ☑️
|
message.created
message.updated
| /gmail.readonly ☑️
/gmail.modify
| Mail.Read ☑️
Mail.ReadWrite
Mail.ReadWrite.Shared
Mail.Read.Shared
|
message.bounce_detected
| /gmail.readonly and /gmail.send ☑️
/gmail.modify
| Mail.Read and Mail.Send ☑️
Mail.ReadWrite and Mail.Send
|
thread.replied
| /gmail.readonly and /gmail.send ☑️
/gmail.modify
| Mail.Read and Mail.Send ☑️
Mail.ReadWrite and Mail.Send
|
folder.created
folder.updated
folder.deleted
| /gmail.readonly ☑️
or /gmail.labels with refactor
/gmail.modify
| Mail.Read ☑️
Mail.ReadWrite
Mail.ReadWrite.Shared
Mail.Read.Shared
|
