Nylas
API integration

list_all_nylas_applications

Get the Nylas application associated with your API key's client ID. Returns: request_id, data.

nylas_applications_bulk_update

Update the Nylas application tied to the client ID of your API key. Requires a request body. Returns: success, data. Nylas replaces all data in any nested object with the values included in the request; this endpoint will be removed in the future when application settings are available in the Nylas Dashboard.

list_all_nylas_applications_redirect_uris

List the callback URIs registered on the Nylas application. Returns each callback URI object with its id, platform, and url.

create_a_nylas_applications_redirect_uris

Add a callback URI to the Nylas application for hosted authentication redirects. Returns the created callback URI object with its id, platform, and url. Depending on the platform, its client_secret is required unless you use OAuth 2.0 with PKCE.

get_single_nylas_applications_redirect_uris_by_id

Get a single callback URI registered on the Nylas application by id. Returns the callback URI object with its id, platform, and url. Required: id.

update_a_nylas_applications_redirect_uris_by_id

Update a callback URI by id; Nylas replaces all data in nested objects with the request values. Returns the updated callback URI object with its id, platform, and url. Required: id.

delete_a_nylas_applications_redirect_uris_by_id

Delete a callback URI from the Nylas application by id. Returns: request_id. Required: id.

list_all_nylas_connectors

List the connectors in your Nylas application. Returns an array of connector records including id, name, provider, settings, and scope. Supported filters: limit, offset.

create_a_nylas_connector

Create a connector in Nylas to store the provider app credentials your application needs to connect to external services. Returns: request_id, data, id, name, provider, settings, scope. The body must include provider; provider-specific variants also require settings.client_id and settings.client_secret (google, microsoft, zoom, yahoo), settings for ews, or only provider (icloud, imap,…

nylas_connectors_bulk_update

Update the connector for the specified provider in Nylas. Nylas replaces all data in nested objects with the values in your request rather than merging them. Returns: request_id, data, id, name, provider, settings, scope. Required: provider.

nylas_connectors_bulk_delete

Delete the Nylas connector for the specified provider. All grants on the connector stop working right away and its credentials are deleted too. Returns an empty 204 response on success. Required: provider.

create_a_nylas_providers_detect

Detect the email provider for an address in Nylas. Returns request_id and data containing the autodetected provider. Required: email.

list_all_nylas_connect_auths

Start the Nylas Hosted OAuth authorization flow: validates the OAuth query parameters and redirects the user (302) to their provider's authorization page via the Location header; supports the authorization code flow with optional PKCE for client-side apps. Required: client_id, redirect_uri, response_type.

create_a_nylas_connect_token

Exchange a Nylas OAuth code, refresh token, or grant id for an access token. Returns: access_token, expires_in, id_token, email, refresh_token, scope, token_type, grant_id, provider. Each OAuth code is one-time-use; a failed…

create_a_nylas_connect_revoke

Revoke a Nylas OAuth access token, including all child tokens and the parent refresh token attached to it (the grant itself stays active, so the user can re-authenticate and the grant_id is unchanged). Returns a success acknowledgement as an unspecified JSON object. Fails if the token is invalid or already expired. Required: token.

list_all_nylas_connect_tokeninfos

Get info about a Nylas OAuth token by passing either an ID token or an access token. Returns: request_id, data.

create_a_nylas_connect_custom

Create a Nylas grant via the Bring Your Own Authentication flow — pass the provider and provider-specific settings (OAuth refresh token, IMAP/SMTP or iCloud credentials, EWS details, or an Agent Account email). Returns: request_id, data. Reuses an existing grant for a previously seen email.

list_all_nylas_grants

List all grants in your Nylas application. Returns: account_id, blocked, created_at, email, grant_status, id, ip, name, provider, provider_user_id, scope, settings, email_aliases, state, updated_at, user_agent, workspace_id, credential_id. All query filters are optional.

get_single_nylas_grant_by_id

Get a single Nylas grant by id. Returns the grant object including its id, email, provider, grant_status, scope, and settings. A grant_status of 'invalid' means the grant has expired and needs to be re-authenticated. Required: id.

update_a_nylas_grant_by_id

Update a grant's provider settings or scope data in Nylas. Omitted top-level fields remain unchanged, and a non-empty settings object replaces (rather than deep merges) the stored settings. Returns: request_id, data. Required: id.

delete_a_nylas_grant_by_id

Permanently delete a Nylas grant by id. The deleted grant cannot be re-authenticated (re-authenticating creates a new grant), and object IDs, sync state, and tracking links may change or break. Returns an empty 204 response on success. Required: id.

nylas_grants_list_events

List events on a Nylas user's calendars for a given grant. Returns event objects including id, title, calendar_id, event_type, when (the event's start/end times or dates), and participants. Required: grant_id, calendar_id.

nylas_grants_attach_event

Create an event on a user's calendar in Nylas for the specified grant. Returns request_id and the created event object (data) including id, calendar_id, title, when, participants, and conferencing. Microsoft and iCloud ignore notify_participants and always email participants about event changes. Required: grant_id, calendar_id, when.

nylas_grants_get_me

Get the current grant in Nylas — the connected account tied to the access token used for the request. Returns request_id and the grant object (data) with id, grant_status, email, provider, and created_at. Requires a user access token; the me shorthand cannot be resolved with an API key alone.

list_all_nylas_workspaces

List all workspaces in your Nylas application; the application queried is determined by the API key used. Returns Workspace objects with: id, name.

create_a_nylas_workspace

Create a workspace in your Nylas application. Returns the created Workspace object including its id, name, domain, auto_group, policy_id, and rule_ids. Requires name. Omit domain to create a workspace that holds only the grants you assign to it. Required: name.

get_single_nylas_workspace_by_id

Get a single Nylas workspace by id. Returns the Workspace object including its id, name, domain, auto_group, policy_id, and rule_ids. Required: id.

update_a_nylas_workspace_by_id

Update a Nylas workspace by id. Returns the updated Workspace object including its id, name, domain, auto_group, policy_id, and rule_ids. The workspace's domain can't be changed after creation. Required: id.

delete_a_nylas_workspace_by_id

Delete a Nylas workspace by id. The workspace's grants keep working and move to the application's default workspace, or become unassigned if there isn't one. You can't delete the application's default workspace. Returns an empty 204 response on success. Required: id.

create_a_nylas_workspaces_auto_group

Start a background auto-grouping job in Nylas that sorts grants not yet in a workspace into workspaces by email domain, creating missing workspaces automatically. Returns: request_id, data. All body parameters are optional; with no filters Nylas considers all unassigned grants.

create_a_nylas_workspace_manual_assign

Assign or remove grants from a Nylas workspace via manual assignment. Returns: request_id, data. At least one grant ID must be given in assign_grants or remove_grants (up to 500 per list); assigning a grant already in another workspace moves it. Required: workspace_id.

list_all_nylas_application_api_keys

List all API keys associated with a Nylas application. Returns request_id and a data array of API keys, each with id, name, api_key, permissions, status, and created_at/expires_at timestamps. Required: application_id.

create_a_nylas_application_api_key

Create an API key for a Nylas application. Returns request_id and a data object with the new key's id, api_key, name, permissions, status, and created_at/expires_at timestamps. Required: application_id.

delete_a_nylas_application_api_key_by_id

Delete an API key from a Nylas application. Returns request_id on success. Required: id, application_id.

get_single_nylas_application_api_key_by_id

Get a single API key for a Nylas application by id. Returns request_id and a data object with the key's id, name, api_key, permissions, status, and created_at/expires_at timestamps. Required: id, application_id.

list_all_nylas_webhooks

List all webhook destinations configured for the Nylas application. Returns each destination with id, webhook_url, trigger_types, status, description, and notification_email_addresses.

create_a_nylas_webhook

Create a Nylas webhook destination that delivers notifications for the given trigger types to an HTTPS endpoint; each destination must have its own unique URL. Returns the new destination including id, webhook_url, trigger_types, status, description, and webhook_secret. Required: trigger_types, webhook_url.

get_single_nylas_webhook_by_id

Get a single Nylas webhook destination by id. Returns the destination including id, webhook_url, trigger_types, status, description, webhook_secret, and notification_email_addresses. Required: id.

update_a_nylas_webhook_by_id

Update a Nylas webhook destination by id, specifying only the fields that need to change (empty fields do not overwrite existing values). Returns the updated destination including id, description, status, and notification_email_addresses. Required: id.

delete_a_nylas_webhook_by_id

Delete a Nylas webhook destination record by id. Returns a success message on success. Required: id.

create_a_nylas_webhooks_rotate_secret

Rotate the webhook secret for a Nylas webhook destination. Returns the updated Destination including its id, webhook_url, trigger_types, status, and the new webhook_secret; the previous secret immediately stops being used. Required: rotate_secret_id.

get_single_nylas_webhooks_mock_payload_by_id

Get a mock Nylas webhook notification payload for the trigger type you specify, to preview what your webhook URL will receive. Returns: request_id, data (mock notification whose fields are specific to the requested trigger_type). Required: trigger_type.

create_a_nylas_webhooks_send_test_event

Send a test webhook event in Nylas to check that a webhook destination is configured correctly; Nylas POSTs a mock notification to the specified webhook_url and waits for a success acknowledgement. Returns the mock notification payload for the requested trigger_type, with fields that vary by trigger type. The test signature is computed with the secret…. Required: trigger_type, webhook_url.

list_all_nylas_channels_pubsubs

List the Pub/Sub notification channels (destinations) configured for the Nylas application. Returns destination records including id, description, topic, trigger_types, notification_email_addresses, status, and compressed_delivery.

create_a_nylas_channels_pubsub

Create a Pub/Sub channel (destination) in the Nylas application that delivers notifications to a Google Pub/Sub topic. Returns the new destination including id, description, topic, trigger_types, status, and compressed_delivery. Requires a destination definition body including trigger_types. Required: trigger_types.

get_single_nylas_channels_pubsub_by_id

Get a specific Pub/Sub channel (destination) from the Nylas application by id. Returns the destination including id, description, topic, trigger_types, notification_email_addresses, status, and compressed_delivery. Required: id.

update_a_nylas_channels_pubsub_by_id

Update a Pub/Sub channel in the Nylas application by id; Nylas replaces all nested data with the request contents. Use status (active or pause) to restart a channel that was paused. Returns the updated destination including id, description, topic, trigger_types, status, and compressed_delivery. Required: id.

delete_a_nylas_channels_pubsub_by_id

Delete a specific Pub/Sub channel from the Nylas application by id. Returns a success message in data along with a request_id. Required: id.

list_all_nylas_channels_sns

List all Amazon SNS notification channels configured for the Nylas application. Returns channels with their id, trigger_types, topic, role_arn, and status. Truto handles pagination.

create_a_nylas_channels_sn

Create a new Amazon SNS notification channel in the Nylas application. Returns the created channel with its id, trigger_types, topic, role_arn, and status. The topic must be a valid Amazon SNS topic ARN starting with `arn:aws:sns:`. Required: trigger_types, topic, role_arn.

get_single_nylas_channels_sn_by_id

Get a specific Amazon SNS notification channel by id. Returns the channel with its id, trigger_types, topic, role_arn, and status. Required: id.

update_a_nylas_channels_sn_by_id

Update an Amazon SNS notification channel by id; a PUT replaces all data in nested objects with the values sent in the request. Returns the updated channel with its id, trigger_types, topic, role_arn, and status. Status can be set to `active` to restart a channel that was paused. Required: id.

delete_a_nylas_channels_sn_by_id

Delete a specific Amazon SNS notification channel by id. Returns a success confirmation envelope with request_id and data. Required: id.

list_all_nylas_connector_creds

List Nylas credentials for a connector provider. Returns credentials with id, name, credential_type, created_at, and updated_at. Supports sort_by (created_at or updated_at) and order_by (asc or desc). Required: provider.

create_a_nylas_connector_cred

Create a credential record for a Nylas connector provider. Returns request_id and data — the created credential with id, name, credential_type, and created_at. credential_type must be connector, serviceaccount, or adminconsent. Required: provider.

get_single_nylas_connector_cred_by_id

Get a Nylas credential by id for a connector provider. Returns request_id and data — the credential object with id, name, credential_type, created_at, and updated_at. Required: id, provider.

update_a_nylas_connector_cred_by_id

Update a Nylas connector credential by id. Nylas replaces all data in the nested credential_data object with the request contents. Returns request_id and data — the updated credential with id, name, credential_type, created_at, and updated_at. Required: id, provider.

delete_a_nylas_connector_cred_by_id

Delete a Nylas credential by id. The connector's default (active) credential can't be deleted, only a non-default one, and grants using the deleted credential stop working immediately. Returns: request_id. Required: id, provider.

list_all_nylas_admin_domains

List all email domains registered to your Nylas organization. Returns: id, name, branded, domain_address, organization_id, region, verified_ownership, verified_dkim, verified_spf, verified_mx, verified_feedback, verified_dmarc, verified_arc, created_at, updated_at. Max 200 per page.

create_a_nylas_admin_domain

Create an email domain in Nylas for use with Transactional Send or Nylas Agent Accounts; its DNS records must be verified before use. Returns: request_id, data. Required: name, domain_address.

get_single_nylas_admin_domain_by_id

Get a single Nylas email domain by id. Returns: request_id, data. Required: id.

update_a_nylas_admin_domain_by_id

Update a Nylas email domain by id. Currently, only the name field can be updated. Returns: request_id, data. Required: id.

delete_a_nylas_admin_domain_by_id

Delete a Nylas email domain by id. This action is irreversible. Returns: request_id. Required: id.

nylas_admin_domains_verify

Trigger a DNS verification check for a domain in Nylas. Returns: request_id, data. Add the required DNS records to the domain's DNS configuration before calling. Required: domain_id, type.

get_single_nylas_domain_info_by_id

Get the DNS record information and verification status for a Nylas domain. Returns request_id and data including domain_id, attempt (the DNS record options to configure at your DNS provider), status, created_at, expires_at, and message. Required: id, type.

list_all_nylas_policies

List all policies for your Nylas application. Returns each policy's id, name, application_id, organization_id, limits, rules, and spam_detection settings.

create_a_nylas_policy

Create a policy for your Nylas application defining message limits, spam detection settings, and linked rules for Agent Accounts. Returns: request_id, data. Required: name.

get_single_nylas_policy_by_id

Get a single Nylas policy by id. Returns the policy object including its id, name, application_id, organization_id, limits, rules, and spam_detection settings. Required: id.

update_a_nylas_policy_by_id

Update a Nylas policy by id. All fields are optional — only provided fields are updated, with the same limit, spam-sensitivity, and retention-period validation as on create. Returns: request_id, data. Required: id.

delete_a_nylas_policy_by_id

Delete a Nylas policy by id. This action is irreversible. Returns: request_id. Required: id.

list_all_nylas_rules

List all rules configured for your Nylas application. Returns rule records including id, name, description, trigger, match, and actions.

create_a_nylas_rule

Create a rule in Nylas that filters or routes email — inbound rules run on incoming messages, outbound rules run on sends before they're submitted to the email provider. Returns the created rule with id, name, trigger, match, and actions. Requires name, match, and actions. Required: name, match, actions.

get_single_nylas_rule_by_id

Get a single Nylas rule by id. Returns the full rule object including id, name, trigger, match, actions, enabled, and priority. Required: id.

update_a_nylas_rule_by_id

Update a Nylas rule by id — only provided fields are changed, and the same validation rules apply as on create. Returns the updated rule including id, name, trigger, match, and actions. Required: id.

delete_a_nylas_rule_by_id

Delete a Nylas rule by id. This action is irreversible — policies referencing the rule stop applying it and outbound sends no longer evaluate it. Returns the request_id of the deletion. Required: id.

list_all_nylas_grant_rule_evaluations

List Nylas rule evaluations for a grant — an audit trail of the rules evaluated against each inbound message, SMTP envelope, or outbound send, which rules matched, and which actions were applied, returned most-recent-first. Returns: id, grant_id, message_id, evaluated_at, evaluation_stage, evaluation_input, applied_actions, matched_rule_ids, application_id, organization_id, created_at,…. Required: grant_id.

list_all_nylas_lists

List all lists for your Nylas application. Returns: id, name, description, type, items_count, application_id, organization_id, created_at, updated_at.

create_a_nylas_list

Create a list in Nylas — a typed collection of values (domains, TLDs, or email addresses) that rules can reference via the in_list condition. Returns: request_id, data, name, provider, settings, scope. Requires name and type; the list type is immutable after creation. Required: name, type.

delete_a_nylas_list_by_id

Delete a Nylas list by id. This action is irreversible and removes all items in the list; rules using the in_list condition on it stop matching its values. Returns only the request_id acknowledgment. Required: id.

get_single_nylas_list_by_id

Get a single Nylas list by id. Returns: request_id, data. Required: id.

update_a_nylas_list_by_id

Update a Nylas list by id — only name and description can be changed; the list type is immutable after creation. Returns: request_id, data. Required: id.

list_all_nylas_list_items

List the items stored in a Nylas list. Returns the items with their id and created_at (Unix timestamp in seconds); item values are validated against the parent list's type (domains, top-level domains, or email addresses). Required: list_id.

create_a_nylas_list_item

Add items to a Nylas list. Values are normalized (lowercased and trimmed) and validated against the list's type; duplicate additions are silently ignored. Returns the updated list object including its name, type, and refreshed items_count. Max 1000 items per request, each at most 500 characters. Required: list_id, items.

nylas_list_items_bulk_delete

Remove items from a Nylas list. Values not currently in the list are silently ignored. Returns the updated list object including its name, type, and refreshed items_count. Max 1000 items per request. Required: list_id, items.

list_all_nylas_grant_messages

List email messages for a Nylas grant. Returns message objects with id, grant_id, subject, date, unread, starred, folders, headers, and metadata; use the fields parameter to request header variants, tracking options, or raw MIME. Nylas recommends filtering results because users receive a large number of messages. Required: grant_id.

update_a_nylas_grant_message_by_id

Update attributes (folders, stars, read/unread status, and so on) of a Nylas email message by id. Returns the updated message object with id, grant_id, subject, date, unread, starred, folders, headers, and metadata. Note that a PUT replaces all data in nested objects, so include all fields you want to keep. Required: id, grant_id.

delete_a_nylas_grant_message_by_id

Delete a Nylas email message by id. If hard_delete is false or omitted, Nylas moves the message to the user's Trash folder; set hard_delete to true to delete it permanently. Returns an empty 200 response on success. Required: id, grant_id.

get_single_nylas_grant_message_by_id

Get a single Nylas email message by id. Returns the message object with id, grant_id, subject, date, unread, starred, folders, headers, and metadata; use the fields parameter to include full headers, tracking options, or raw MIME. Required: id, grant_id.

nylas_messages_cleans_bulk_update

Clean one or more Nylas messages for a grant, removing extra information such as scripts, styles, links, images, and tables from the message content. Returns request_id and a data array of cleaned messages including body and conversation content. Requires grant_id and message_id. Nylas strips all extra information (such as