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://api.zeptomail.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.

- Request Body

application/json
JSON Object
Show Sub-Attributes
new_sub_domain_prefixstringOptional

Updated subdomain prefix.

associate_mailagentsarrayOptional

Array of Mail Agent keys to associate with this domain.

unassociate_mailagentsarrayOptional

Array of Mail Agent keys to unassociate from this domain.

new_domainstringOptional

Updated domain name.

Sample Request

Curl
Java
Python
Deluge
Copied!
curl --request PUT \
  --url https://api.zeptomail.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
dataJSON Object
Show Sub-Attributes
dkim_statusstring
created_timestring
domain_namestring
domain_keystring
sub_domain_prefixstring
spf_statusstring
is_verifiedboolean
statusstring

- HTTP code 400

Response Body - application/json
JSON Object
Show Sub-Attributes
errorJSON Object
Show Sub-Attributes
codestring
messagestring
statusstring

Possible Response Codes

200HTTP code

Domain updated successfully.

400HTTP code

Bad Request

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