Domain Details API
The Domain Details APIs help you to get information about the domains in the particular organization, verification information, mail hosting status etc.
While using Domain related API, use the scope ZohoMail.organization.domains.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
| Add Domain to an Organization | /api/organization/{zoid}/domains | POST | ZohoMail.organization.domains | Add a domain to the organization. |
| Fetch All Domains | /api/organization/{zoid}/domains | GET | Fetch the details of all the domains in the organization. | |
| Fetch a Specific Domain | /api/organization/{zoid}/domains/{domainname} | GET | Fetch the details of a single domain in the organization. | |
| Verify a Domain in the Organization | /api/organization/{zoid}/domains/{domainname} | PUT | Verify the domain by one of the verification methods. | |
| Set a Domain as Primary | /api/organization/{zoid}/domains/{domainname} | PUT | Make the domain as Primary domain in the Organization. | |
| Enable Email Hosting for a Domain | /api/organization/{zoid}/domains/{domainname} | PUT | Enable Email Hosting for the specific domain | |
| Verify SPF record | /api/organization/{zoid}/domains/{domainName} | PUT | To verify SPF record of your domain. | |
| Verify MX record | /api/organization/{zoid}/domains/{domainName} | PUT | To verify MX record of your domain. | |
| Add a Domain Alias | /api/organization/{zoid}/domains/{domainname} | PUT | Make the domain as an alias to the other domain. | |
| Remove the Domain Alias | /api/organization/{zoid}/domains/{domainname} | PUT | Remove the alias marking between the domains. | |
| Add DKIM details | /api/organization/{zoid}/domains/{domainName} | PUT | To add a DKIM detail for your domain. | |
| Set a DKIM details as default | /api/organization/{zoid}/domains/{domainName} | PUT | To set a DKIM detail as default for your domain. | |
| Delete a DKIM details | /api/organization/{zoid}/domains/{domainName} | PUT | To delete a present DKIM detail of your domain. | |
| Regenerate DKIM Public Key | /api/organization/{zoid}/domains/{domainName} | PUT | To regenerate the existing DKIM detail of your domain. | |
| Verify DKIM public key | /api/organization/{zoid}/domains/{domainName} | PUT | To verify the DKIM public key of your domain. | |
| Enable subdomain stripping | /api/organization/{zoid}/domains/{domainName} | PUT | To enable sub-domain stripping for your domain. | |
| Disable subdomain stripping | /api/organization/{zoid}/domains/{domainName} | PUT | To disable sub-domain stripping for your domain. | |
| Add catchall address | /api/organization/{zoid}/domains/{domainName} | PUT | To make an email address available in your organization as the catch-all account. | |
| Delete catchall address | /api/organization/{zoid}/domains/{domainName} | PUT | To delete the catchall account of your domain. | |
| Add notification address | /api/organization/{zoid}/domains/{domainName} | PUT | To make an email address available in your organization as the notification address. | |
| Delete notification address | /api/organization/{zoid}/domains/{domainName} | PUT | To delete the notification address of your domain. | |
| Delete a Domain from the Organization | /api/organization/{zoid}/domains/{domainname} | DELETE | Delete the domain from the Organization. |