Sending Domains
POST
Add Sending Domain
POST /v1/domainsAdd a new sending domain to your workspace.
Use Cases:
- Configure a custom sending domain for branded emails
- Add multiple domains for different business units
- Set up a domain for transactional email delivery
- Register a domain before DNS verification
Behavior:
- Domain name is validated for correct format
- DNS records are generated automatically for setup
- Domain is created in unverified state
- DKIM key pair is generated for the domain
- You must configure DNS records before the domain can be used
- Returns the domain with required DNS records to configure
Required Scope: write:domains
After Creation:
- Add the returned DNS records to your domain's DNS configuration
- Call POST /v1/domains/{domainId}/verify to check DNS propagation
- Once verified, the domain can be used for sending emails
DNS Records Required:
- DKIM: TXT record for email authentication
- Return Path: CNAME record for bounce handling
- Tracking: CNAME record for open/click tracking
Note: DNS propagation can take up to 48 hours. Use the verify endpoint to check status.
Bodyrequired
namestringrequiredMin length: 1Max length: 100
dmarcEnabledbooleanResponse
201Sending domain created successfully. Returns the domain with DNS records to configure.
objectstringrequiredidstringrequirednamestringrequireddkimVerifiedbooleanrequiredreturnPathVerifiedbooleanrequiredtrackingVerifiedbooleanrequiredopenTrackingEnabledbooleanrequiredclickTrackingEnabledbooleanrequireddnsRecordsobjectrequiredcreatedAtstringrequiredsslStatusanyrequiredsslErroranyrequired