Generate API keys

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

Generate a new API key for a specific Mail Agent.

Request URL

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

Scope

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

Request Parameters

- Path Parameters

mailagentkeystringMandatory

Unique key of the Mail Agent.

Sample Request

Curl
Java
Python
Deluge
Copied!
curl --request POST \
  --url https://cpaas.zoho.com/v1.1/mailagents/{mailagentkey}/apikeys \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Show Sub-Attributes
dataJSON Object
Show Sub-Attributes
created_timestring
idstring
tokenstring
statusstring

- HTTP code 400

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

Sample Response: HTTP 200

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

Sample Response: HTTP 400

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