agents

Generate API keys

Generate a new API key for a specific Mail Agent.

post/mailagents/{mailagentkey}/apikeys

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

Path parameters

mailagentkeystring required
Example:123456abcd78

Unique key of the Mail Agent.

Response

New API key generated successfully.

statusstring

Example response

{
  "data": {
    "created_time": "2025-06-12T11:50:00Z",
    "id": "apikey-002",
    "token": "Zoho-enczapikey yyyy"
  },
  "status": "success"
}

Changes

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