Edit MailAgent

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 name or description of an existing Mail Agent.

Endpoint

Request URL

https://cpaas.zoho.com/v1.1/mailagents/{mailagentkey} Copied!

Scope

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

Request Parameters

- Path Parameters

mailagentkeystringMandatory

Unique key of the Mail Agent.

Example
123456abcd78

- Request Body

application/json
JSON Object
Show Sub-Attributes
mailagent_namestringOptional

Name for the Mail Agent. Must be unique within the account.

Example
Mail_agent_name
descriptionstringOptional

Description or purpose of the Mail Agent.

Example
Production mail agent for transactional emails

Sample Request

Curl
Java
Python
Deluge
Copied!
curl --request PUT \
  --url https://cpaas.zoho.com/v1.1/mailagents/{mailagentkey} \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"mailagent_name":"Mail_agent_name","description":"Production mail agent for transactional emails"}'

Sample Request Body

Copied!
  {
    "mailagent_name": "Mail_agent_name",
    "description": "Production mail agent for transactional emails"
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Show Sub-Attributes
dataobject
mailagent_namestringread-only
Example
mailagent_1
created_timestringread-only
Example
04 Jun 2025 08:19 PM
descriptionstringread-only
Example
Production mail agent
mailagent_keystringread-only
Example
123456abcd78
statusstringread-only
Example
active
statusstringread-only
Example
success

- HTTP code 400

Response Body - application/json
JSON Object
Show Sub-Attributes
errorJSON Object
Show Sub-Attributes
codestringread-only
Example
MA_107
messagestringread-only
Example
Mail agent name already exists
statusstringread-only
Example
failure

Sample Response: HTTP 200

Copied!
  {
    "data": {
      "mailagent_name": "mailagent_1",
      "created_time": "04 Jun 2025 08:19 PM",
      "description": "Production mail agent",
      "mailagent_key": "123456abcd78",
      "status": "active"
    },
    "status": "success"
  }
                
▼ Show full

Sample Response: HTTP 400

Copied!
  {
    "error": {
      "code": "MA_107",
      "message": "Mail agent name already exists"
    },
    "status": "failure"
  }
                
▼ Show full