List all MailAgents

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

Retrieve a list of all Mail Agents in your ZeptoMail account.

Endpoint

get /mailagents

Request URL

https://api.zeptomail.com/v1.1/mailagents Copied!

Scope

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

Sample Request

Curl
Java
Python
Deluge
Copied!
curl --request GET \
  --url https://api.zeptomail.com/v1.1/mailagents \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Show Sub-Attributes
dataJSON Array
Show Sub-Attributes
JSON Object
Show Sub-Attributes
mailagent_namestring
created_timestring
descriptionstring
mailagent_keystring
statusstring
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

List of Mail Agents.

400HTTP code

Bad Request

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