Amazon SNS Notifications5

App migration5

Application-level templates7

Application-level workflows5

Applications7

Attachments4

Authentication APIs4

Availability1

Bookings5

Calendar7

Configurations5

Connector credentials5

Connectors (Integrations)6

Contacts6

Data migration1

Drafts6

Events7

Folders5

Grant-level templates7

Grant-level workflows5

Group Events6

IAM credentials5

IAM principals5

Lists8

Manage API keys4

Manage Domains7

Manage Grants10

Messages9

Notetaker9

Notetaker Configurations5

Policies5

Pub/Sub Notifications5

Room resources1

Rules6

Send alerts5

Send events6

Sessions2

Signatures5

Smart compose2

Standalone Notetaker9

Threads4

Tracking events6

Transactional send1

v2 Redirects1

Webhook Notifications8

Workspaces7

Grant-level workflows

Create a workflow

Changed on Nov 6, 2026

Creates a grant-level workflow.

<div id="admonition-info">ℹ️ <b>You must have an existing <a href="/docs/reference/api/grant-level-templates/">template</a> to create a workflow</b>.</div>

post/v3/grants/{grant_id}/workflows

Request

Base URL
https://api.us.nylas.com
Auth
- HTTP bearer
- or HTTP bearer

Request body

delayinteger

The number of minutes between a trigger_event being met and the workflow sending a message.

is_enabledboolean

When true, indicates that the workflow is enabled.

namestring required

The name of the workflow.

template_idstring required

The ID of the email template the workflow uses.

The event which triggers the workflow.

grant.expired and grant.deleted require a from sender address, because the grant that triggered them can no longer send email. Every other trigger accepts a workflow without one.

Workflows have no condition or filter field, so an enabled workflow sends for every matching event in its scope. High-volume triggers such as message.opened fire for every open of every tracked message the workflow covers.

Example request

{
  "delay": 5,
  "is_enabled": true,
  "name": "New booking confirmation workflow",
  "template_id": "14c00cc8-648c-4381-ad10-52641d9bac8e",
  "trigger_event": "booking.created",
  "from": {
    "email": "support@example.com",
    "name": "Support"
  }
}

Response

Success. Returns workflow.

request_idstring required

The ID of the request.

Example response

{
  "data": {
    "app_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
    "date_created": 1756477389,
    "delay": 5,
    "grant_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
    "id": "b79c82b2-a51b-4c54-8469-28006a43551a",
    "is_enabled": true,
    "name": "New booking confirmation workflow",
    "template_id": "14c00cc8-648c-4381-ad10-52641d9bac8e",
    "trigger_event": "booking.created",
    "from": {
      "email": "support@example.com",
      "name": "Support"
    }
  }
}

Changes

Nov 6, 20267782a3e3ab70 Revision changes
- breaking
  removed the enum value message.created of the request property
- breaking
  removed the enum value message.updated of the request property
- info
  removed the message.created enum value from the / response property for the response status
- info
  removed the message.updated enum value from the / response property for the response status
Sep 24, 20265b50586c3710 Revision changes
- warning
  added the new calendar.created enum value to the / response property for the response status
- warning
  added the new calendar.deleted enum value to the / response property for the response status
- warning
  added the new calendar.updated enum value to the / response property for the response status
- warning
  added the new contact.deleted enum value to the / response property for the response status
- warning
  added the new contact.updated enum value to the / response property for the response status
- warning
  added the new event.created enum value to the / response property for the response status
- warning
  added the new event.deleted enum value to the / response property for the response status
- warning
  added the new event.updated enum value to the / response property for the response status
- warning
  added the new folder.created enum value to the / response property for the response status
- warning
  added the new folder.deleted enum value to the / response property for the response status
- warning
  added the new folder.updated enum value to the / response property for the response status
- warning
  added the new grant.created enum value to the / response property for the response status
- warning
  added the new grant.deleted enum value to the / response property for the response status
- warning
  added the new grant.expired enum value to the / response property for the response status
- warning
  added the new grant.imap_sync_completed enum value to the / response property for the response status
- warning
  added the new grant.updated enum value to the / response property for the response status
- warning
  added the new message.bounce_detected enum value to the / response property for the response status
- warning
  added the new message.created enum value to the / response property for the response status
- warning
  added the new message.link_clicked enum value to the / response property for the response status
- warning
  added the new message.opened enum value to the / response property for the response status
- warning
  added the new message.send_failed enum value to the / response property for the response status
- warning
  added the new message.send_success enum value to the / response property for the response status
- warning
  added the new message.updated enum value to the / response property for the response status
- warning
  added the new notetaker.created enum value to the / response property for the response status
- warning
  added the new notetaker.deleted enum value to the / response property for the response status
- warning
  added the new notetaker.media enum value to the / response property for the response status
- warning
  added the new notetaker.meeting_state enum value to the / response property for the response status
- warning
  added the new notetaker.updated enum value to the / response property for the response status
- warning
  added the new thread.replied enum value to the / response property for the response status
- info
  added the new calendar.created enum value to the request property
- info
  added the new calendar.deleted enum value to the request property
- info
  added the new calendar.updated enum value to the request property
- info
  added the new contact.deleted enum value to the request property
- info
  added the new contact.updated enum value to the request property
- info
  added the new event.created enum value to the request property
- info
  added the new event.deleted enum value to the request property
- info
  added the new event.updated enum value to the request property
- info
  added the new folder.created enum value to the request property
- info
  added the new folder.deleted enum value to the request property
- info
  added the new folder.updated enum value to the request property
- info
  added the new grant.created enum value to the request property
- info
  added the new grant.deleted enum value to the request property
- info
  added the new grant.expired enum value to the request property
- info
  added the new grant.imap_sync_completed enum value to the request property
- info
  added the new grant.updated enum value to the request property
- info
  added the new message.bounce_detected enum value to the request property
- info
  added the new message.created enum value to the request property
- info
  added the new message.link_clicked enum value to the request property
- info
  added the new message.opened enum value to the request property
- info
  added the new message.send_failed enum value to the request property
- info
  added the new message.send_success enum value to the request property
- info
  added the new message.updated enum value to the request property
- info
  added the new notetaker.created enum value to the request property
- info
  added the new notetaker.deleted enum value to the request property
- info
  added the new notetaker.media enum value to the request property
- info
  added the new notetaker.meeting_state enum value to the request property
- info
  added the new notetaker.updated enum value to the request property
- info
  added the new thread.replied enum value to the request property

Operation history