Edit Domain

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

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

Endpoint

Request URL

https://cpaas.zoho.com/v1.1/domains/{domain_key} Copied!

Scope

Zeptomail.Domains.UPDATECopied!
(or)
Zeptomail.Domains.ALLCopied!

Request Parameters

- Path Parameters

domain_keystringMandatory

Unique key of the domain.

Example
domain-xxxx

- Request Body

application/json
JSON Object
Show Sub-Attributes
new_sub_domain_prefixstringOptional

Updated subdomain prefix.

Example
demo
associate_mailagentsarray[string]Optional

Array of Mail Agent keys to associate with this domain.

Example
[]
unassociate_mailagentsarray[string]Optional

Array of Mail Agent keys to unassociate from this domain.

Example
[]
new_domainstringOptional

Updated domain name.

Example
newdomain.com

Sample Request

Curl
Java
Python
Deluge
Copied!
curl --request PUT \
  --url https://cpaas.zoho.com/v1.1/domains/{domain_key} \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"new_sub_domain_prefix":"demo","associate_mailagents":[],"unassociate_mailagents":[],"new_domain":"newdomain.com"}'

Sample Request Body

Copied!
  {
    "new_sub_domain_prefix": "demo",
    "associate_mailagents": [],
    "unassociate_mailagents": [],
    "new_domain": "newdomain.com"
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Show Sub-Attributes
dataobject
dkim_statusstringread-only
Example
verified
created_timestringread-only
Example
2025-06-04T08:19:00Z
domain_namestringread-only
Example
zylker.com
domain_keystringread-only
Example
domain-xxxx
sub_domain_prefixstringread-only
Example
mail
spf_statusstringread-only
Example
verified
is_verifiedbooleanread-only
Example
true
statusstringread-only
Example
success

- HTTP code 400

Response Body - application/json
JSON Object
Show Sub-Attributes
errorJSON Object
Show Sub-Attributes
codestringread-only
Example
DM_400
messagestringread-only
Example
Invalid domain
statusstringread-only
Example
failure

Sample Response: HTTP 200

Copied!
  {
    "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"
  }
                
▼ Show full

Sample Response: HTTP 400

Copied!
  {
    "error": {
      "code": "DM_400",
      "message": "Invalid domain"
    },
    "status": "failure"
  }
                
▼ Show full