ZOzoho
agents

Add MailAgent

Create a new Mail Agent in your CPaaS account. You can create up to 50 agents per account.

post/mailagents

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.MailAgents.CREATE
    • or OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.MailAgents.ALL

Request body

mailagent_namestring required

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

descriptionstring

Description or purpose of the Mail Agent.

Example request

{
  "mailagent_name": "Mail_agent_name",
  "description": "Production mail agent for transactional emails"
}

Response

Mail Agent created successfully.

statusstring

Example response

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

Changes

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