ZOzoho
domains

Edit Domain

Update the details of an existing domain, including its name, subdomain prefix, and Mail Agent associations.

put/domains/{domain_key}

Request

  • Base URL
    https://cpaas.zoho.com/v1.1
  • Auth
    • OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.Domains.UPDATE
    • or OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.Domains.ALL

Path parameters

domain_keystring required
Example:domain-xxxx

Unique key of the domain.

Request body

new_sub_domain_prefixstring

Updated subdomain prefix.

associate_mailagentsstring[]

Array of Mail Agent keys to associate with this domain.

unassociate_mailagentsstring[]

Array of Mail Agent keys to unassociate from this domain.

new_domainstring

Updated domain name.

Example request

{
  "new_sub_domain_prefix": "demo",
  "associate_mailagents": [],
  "unassociate_mailagents": [],
  "new_domain": "newdomain.com"
}

Response

Domain updated successfully.

statusstring

Example response

{
  "data": {
    "dkim_status": "verified",
    "created_time": "2025-06-04T08:19:00Z",
    "domain_name": "zylker.com",
    "domain_key": "domain-xxxx",
    "sub_domain_prefix": "mail",
    "spf_status": "verified",
    "is_verified": true
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.