Skip to content
Skip to main content
POST
https://api.us.nylas.com/v3/domains

Create domain

Registers 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, verify its DNS records.

Nylas rejects fields other than name and domain_address.

Requires an IAM API key with the domains.create permission. Application API keys and access tokens don't work.

Request body

name*string

A human-readable label for the domain.

Example: "Transactional mail"
domain_address*string

The domain to register, such as mail.example.com. Don't include a protocol, path, or trailing dot.

Example: "mail.example.com"
minLength: 3maxLength: 512

Responses

request_idstring

ID of the request.

Example: "582538585-ff20ff48-7cf7-4e8a-acf3-bc1104f87748"
dataobject
POSThttps://api.us.nylas.com/v3/domains

Paste the authorization token required for this endpoint.

Loading editor...

Autocomplete and validation come from this endpoint's request schema.