POST - Add Domain to Organization

Purpose

The API adds the specified domain to the given organization.  

OAuth Scope

Use the scope

ZohoMail.organization.domains.ALL (or) ZohoMail.organization.domains.CREATE

to generate the Authtoken.

ALL - Grants full access to domains.

CREATE - Grants create access to domains.

Request URL

Method: POST

 https://mail.zoho.com/api/organization/{zoid}/domains

Path Parameters

  • zoid* long
    • This parameter specifies the unique Zoho Organization Identifier for the organization.
    • This parameter can be fetched from Get Organization Details API.

 

Request Body(JSON Object)

  • domainName* string
    • This parameter specifies the name of the domain that needs to be added.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/domains" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \
-d '{
    "domainName": "zylkernew.com",
}'

Sample Response

Copied{
   "status": {
       "code": 201,
       "description": "Created"
   },
   "data": {
       "HTMLVerificationCode": "60906216",
       "verificationStatus": false,
       "domainName": "zylkernew.com",
       "createdTime": 1722937359902,
       "CNAMEVerificationCode": "zb60906216",
       "isRegisteredByZoho": false,
       "primary": false
   }
}