Create a domain
create_domainCreate a domain.
Registers a domain and returns the DNS records to add (three DKIM CNAMEs, plus MX and SPF on the MAIL FROM subdomain). Domain names are globally unique. The number of domains is limited by your plan (Free 3, Pro 10, Scale 1,000).
The response lists the DNS records (DKIM CNAMEs, MAIL FROM MX and SPF TXT) the user must add at their DNS provider; afterwards call verify_domain and then get_domain to see the new status. DNS changes can take minutes to hours.
Requires a full_access API key. API: POST /domains (operationId createDomain, Domains).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Domain or subdomain you own. Lower-cased. | |
| region | No | Accepted for compatibility. The region is chosen by the platform and returned on the domain. | |
| tenant_id | No | Platform mode. Make the domain tenant-owned (our tenant id or your `external_id`). Mail from it is attributed to that tenant. | |
| custom_return_path | No | Subdomain used for the custom MAIL FROM (bounce handling and SPF). | send |