Skip to content
Skip to main content

Manage Domains API now uses IAM API keys

PlatformEmailAgent Accounts

The Manage Domains API now uses /v3/domains and authenticates with an IAM API key. You no longer need a Nylas Service Account to register and verify the domains you use with Transactional Send and Agent Accounts.

Changed

Section titled “Changed”
  • New endpoint path. The Manage Domains endpoints moved from /v3/admin/domains to /v3/domains. For example, register a domain with POST /v3/domains, and verify it with POST /v3/domains/{domain_id}/verify.
  • IAM API key authentication. Send an IAM API key as a bearer token. Its principal needs an Organization binding and the 4 Domains permissions: domains.read, domains.create, domains.update, and domains.delete. You no longer sign requests with Service Account headers. See Create an IAM API key for domains.

Documentation

Section titled “Documentation”
  • Domains guide. Manage email domains with the Domains API now walks through creating the IAM API key in the Dashboard, with screenshots. It also shows the full register-and-verify flow as a diagram, plus the DNS records to add and common errors.
  • IAM permissions reference. The new Nylas IAM permissions reference lists every direct permission and the resource binding each one needs.
  • API reference. The Manage Domains API reference uses the new paths and IAM API key auth. It also documents the dmarc and arc verification types, the 2048-bit DKIM key option, and looking up a domain by its address instead of its ID.