Command
nylas dashboard domains check
Check whether a domain is already registered in your organization.
Written by Qasim Muhammad Staff SRE
What does nylas dashboard domains check do?
The nylas dashboard domains check command checks whether a domain is already registered in your Dashboard organization and reports the conflicting region when it is taken. Run it before registering a free *.nylas.email subdomain for Agent Accounts.
Usage
nylas dashboard domains check [domain]Flags
| Flag | Description |
|---|---|
| --json | Output as JSON |
| --no-color | Disable color output |
| --verbose(-v) | Enable verbose output |
| --config | Custom config file path |
| --help(-h) | Show help for the command |
| --limit | Limit results (most list commands) |
| --yes(-y) | Skip confirmations |
Examples
The nylas dashboard domains check command checks whether a domain is already registered in your Dashboard organization and reports the conflicting region when it is taken.
Check a free Agent Account email domain
nylas dashboard domains check myagent.nylas.emailExample output
Domain: example.com
Registered: no
example.com is available to register in your organization.Troubleshooting
Domain is unavailable
Pick another subdomain, or inspect the existing domain with `nylas dashboard domains show <domain>`. Pass the reported region only if you need to override inference.
Recommended guides
Build a Mastra Email Agent
Give a Mastra TypeScript agent email by wrapping the Nylas CLI as a createTool — one subprocess call, JSON in and out, across Gmail, Outlook, and more.
Add Email Sync to Your App Without IMAP
Skip per-mailbox IMAP IDLE connections. Use webhooks for push and on-demand reads for backfill, prototyped from the terminal — and know when IMAP still wins.
Automate Customer Onboarding Emails
Run a multi-day onboarding sequence from a signup hook with nylas email send --schedule and hosted templates — no marketing platform, no SMTP.
Build a Transactional Email Agent
Send receipts, confirmations, and alerts from a dedicated agent account — DKIM-signed, idempotent, and rate-capped by a workspace policy, no SMTP relay.
Trigger Agents on Inbound Email with Webhooks
Replace cron polling with webhooks: register a message.created hook so your agent account wakes the agent the instant mail arrives, signature-verified.
Build an Email Digest Agent
Send an opt-in digest to a subscriber group from an agent account — resolve the recipient list from contacts, honor unsubscribes, and send on a schedule.
Run nylas dashboard domains check --help for full help output.