PUT - Remove Domain Alias

Purpose

The API removes the existing domain alias and disassociates the domain from the other domain.Learn more about Domain Alias here.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Grants full access to domains.

UPDATE - Grants update access to domains.

Request URL

Method: PUT

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

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.
  • domainName* string
    • This parameter specifies the name of the domain whose domain alias needs to be removed.

 

Request Body(JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as removeDomainAlias.
  • domainAlias* string
    • This parameter specifies the name of the domain that should be removed as alias to the specified domain.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/domains/zylker.com" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \
-d ' {
   "mode": "removeDomainAsAlias",
   "domainAlias": "zylkertraining.com"
}'

Sample Response

Copied{
   "status": {
       "code": 200,
       "description": "success"
   }
}