Managing Email Domains
Use your own custom domains to send emails, improving deliverability and maintaining brand consistency.List All Domains
View all domains currently registered with your account.Parameters
No parameters required.Response
object[]
Array of all domains registered with your account, including their verification status and configuration details.
object
Request metadata including ID, timestamp, and API version.
Get Domain Details
Get detailed information about a specific domain, including verification status and DNS records.Parameters
string
required
Domain name (e.g.
"example.com"). Passed as first argument.Response
string
Current verification status of the domain (e.g., “verified”, “pending”, “failed”).
object[]
Array of DNS records required for domain verification and email sending.
object
Detailed verification status for each DNS record type (DKIM, SPF, DMARC).
object
Request metadata including ID, timestamp, and API version.
Register a Domain
Add a new domain to your account for sending emails.Parameters
string
required
Domain name to register (e.g.
"example.com"). First argument.object
Optional.
region, custom_return_path, etc.Response
string
Registration status of the domain (e.g., “registered”, “pending_verification”).
object[]
Array of DNS records that must be added to your domain’s DNS settings for verification.
object
Request metadata including ID, timestamp, and API version.
Delete a Domain
Remove a domain from your account when it’s no longer needed.Parameters
string
required
Domain name to delete. Passed as first argument.
Response
boolean
Indicates whether the domain was successfully deleted.
string
Confirmation message about the deletion status.
object
Request metadata including ID, timestamp, and API version.
Using Custom Domains
Once your domain is verified, you can use it to send emails with your brand:Domain Verification
After registering a domain, you’ll need to:- Add DNS records provided in the registration response to your domain’s DNS settings
- Verify ownership by ensuring the DNS records are properly configured
- Wait for verification which typically takes a few minutes to complete
domains.get() method.
Make sure to add all required DNS records (DKIM, SPF, DMARC) to ensure optimal email deliverability and to prevent your emails from being marked as spam.
