Manage Domains
Register and verify the domains you use with Transactional Send and Nylas Agent Accounts. Domains belong to your Nylas organization, so they work across all of your applications.
Authentication
Use an IAM API key whose principal has an Organization binding and the Domains permissions (domains.read, domains.create, domains.update, and domains.delete). Application API keys and access tokens don't work. For setup steps, see Create an IAM API key for domains.
Domain verification
New domains start unverified. For each verification type, call Get domain info to get the DNS record, add it at your DNS provider, then call Verify domain.
| Type | Required for | Record |
|---|---|---|
ownership |
All domains | TXT record that proves you own the domain. |
dkim |
Transactional Send, Agent Accounts | TXT record for DKIM signing. |
spf |
Transactional Send, Agent Accounts | TXT record that authorizes Nylas to send. |
feedback |
Transactional Send, Agent Accounts | MX record for bounce reports. |
mx |
Agent Accounts | MX record that routes incoming mail. |
For the full walkthrough, see Managing domains.
GET /v3/domainsLists your organization's domains, newest first. To get the next page, pass next cursor as page token. When a response doesn't include next cursor, there are no more results.
POST /v3/domainsRegisters a domain to your organization. To set up authentication, see Create an IAM API key for domains. New domains start unverified. Before you use one with Transactional Send or Agent Accounts, ve...
GET /v3/domains/{domain_id}Returns a domain. You can use the domain address in place of the domain ID.
PUT /v3/domains/{domain_id}Renames a domain. name is the only field you can change. To use a different address, register a new domain and delete the old one.
DELETE /v3/domains/{domain_id}Deletes a domain from your organization. Send the request without a body or query parameters.
POST /v3/domains/{domain_id}/infoReturns the DNS record to add for one verification type. Call this endpoint for each type you need, add the records at your DNS provider, then call Verify domain. Record hosts are relative to your roo...
POST /v3/domains/{domain_id}/verifyChecks the DNS record for one verification type. The response is 200 whether or not the record is verified, so check status. If it's failed, wait a few minutes and try again. SPF, DKIM, and feedback r...