Command

nylas dashboard domains create

Register a domain for Nylas Inbox and Agent Accounts.

Written by Qasim Muhammad Staff SRE

What does nylas dashboard domains create do?

The nylas dashboard domains create command registers a domain in your active Dashboard organization. Use a free <subdomain>.nylas.email domain for Agent Account addresses, and pass --region us or --region eu to match the application region created during nylas init.

Usage

nylas dashboard domains create [domain] --region <region>

Flags

FlagDescription
--jsonOutput as JSON
--no-colorDisable color output
--verbose(-v)Enable verbose output
--configCustom config file path
--help(-h)Show help for the command
--limitLimit results (most list commands)
--yes(-y)Skip confirmations
--domainDomain address to register
--name(-n)Display name (defaults to the domain)
--region(-r)Region to register in (required: us or eu)

Examples

The nylas dashboard domains create command registers a domain in your active Dashboard organization.

Register a US free domain

nylas dashboard domains create myagent.nylas.email --region us

Register an EU free domain

nylas dashboard domains create myagent.nylas.email --region eu

Create an Agent Account on that domain

nylas agent account create user@myagent.nylas.email

Example output

✓ Domain registered (dom_abc123)
  Address: example.com
  Region:  us
  Status:  pending

Next: run 'nylas dashboard domains dns dom_abc123' and add the DNS records.

Troubleshooting

Region is required

Pass the same region as your active app. Use `nylas dashboard apps list` to confirm whether the app is in us or eu.

Domain is already registered

Run `nylas dashboard domains check <domain>` to see which region already owns it, then choose a different subdomain if needed.

Recommended guides

Run nylas dashboard domains create --help for full help output.