Learn how to use Domain API V6.
Overview
The Domain API allows you to manage domains for email sending, DNS configuration, and email routing. With this API, you can add, delete, verify, and list domains in your account. You can also configure envelope and inbound settings, validate DNS records, and allocate domains to subaccounts. This is essential for managing your sending domains, ensuring email deliverability, and monitoring DNS configurations.
Key Features:
- Add and remove domains.
- Fetch domain details and their DNS setup (including DKIM, SPF, etc.)
- Validate DNS configurations (DKIM, envelope sender, inbound routing)
- Allocate domains to subaccounts for independent use.
Endpoints
Refer to the given table to know the endpoints under Domain API.
| Endpoint Name | Method | Endpoint | Description |
|---|---|---|---|
| Add Domain | POST | /v6/domains | Adds a new domain to your account for email sending and configures optional envelope and inbound settings. |
| Get Domain | GET | /v6/domains/{domain_name} | Fetches the current status, tracking configuration, and DNS setup of a specific domain. |
| List Domains | GET | /v6/domains | Retrieves a list of all domains under your account, with filtering and pagination options. |
| Verify Domain | GET | /v6/domains/validate/{domain_name} | Triggers a DNS validation check to verify DKIM, envelope sender, and inbound routing configurations for a domain. |
| Delete Domain | DELETE | /v6/domains/{domain_name} | Removes a domain from your account, ensuring it is no longer associated with email sending. |
| Allocate Domain to Subaccount | POST | /v6/domains/allocate | Assigns a domain to a subaccount so it can be used independently under that context. |