API index guide
API or Application Programming Interface acts as a connection between applications or softwares, by allowing them to adopt specific functionalities (navigation, emails, payment etc.) within their application. One such functionality that application owners can adopt is transactional email-sending and related actions. This page lists all the APIs available in ZeptoMail.
The total email size which includes your email headers, body content, inline images, and attachments should NOT exceed 15 MB.
Email-sending API
| Method name | Method type | URL |
| Send single email | POST | /v1.1/email |
| Send batch email | POST | /v1.1/email/batch |
| Send single email with template | POST | /v1.1/email/template |
| Send batch email with template | POST | /v1.1/email/template/batch |
File cache API
| Method name | Method type | URL |
| Upload File cache | POST | /v1.1/files?name=logo.jpg |
Suppression list API
| Method name | Method type | URL | OAuth scope | Operation |
| Add a suppression list entry | POST | /v1.1/suppressions/{type} | Zeptomail.Suppressions.All | CREATE |
| Edit a suppression list entry | PUT | /v1.1/suppressions/{type} | UPDATE | |
| Fetch suppression list entries | GET | /v1.1/suppressions/{type} | READ | |
| Delete a suppression list entry | DELETE | /v1.1/suppressions/{type} | DELETE |
Templates API
| Method name | Method type | URL | OAuth scope | Operation |
| Add a new template | POST | /v1.1/agents/{agent-alias}/templates | Zeptomail.MailTemplates.All | CREATE |
| Edit an existing templates | PUT | /v1.1/agents/{agent-alias}/templates/{template-key} | UPDATE | |
| Fetch single template | GET | /v1.1/agents/{agent-alias}/templates{template-key} | READ | |
| Fetch multiple templates | GET | /v1.1/agents/{agent-alias}/templates?offset=*&limit=* | READ | |
| Delete a template | DELETE | /v1.1/agents/{agent-alias}/templates{template-key} | DELETE |
Domains API
| Method name | Method type | URL | OAuth scope | Operation |
| Add a new domain | POST | /v1.1/domains | Zeptomail.Domains.All | CREATE |
| Edit domain | PUT | /v1.1/domains/{domain_key} | UPDATE | |
| List all domains | GET | /v1.1/domains | READ | |
| List specific domains | GET | /v1.1/domains/{domain_key} | READ | |
| Validate domain verification | PUT | /v1.1/domains/{domain_key}/verify | UPDATE | |
| Delete domain | DELETE | /v1.1/domains/{domain_key} | DELETE |
Agents API
| Method name | Method type | URL | OAuth scope | Operation |
| Add a new Agent | POST | /v1.1/agents | Zeptomail.Agents.All | CREATE |
| Edit existing Agent | PUT | /v1.1/agents/{agentkey} | UPDATE | |
| List all Agents | GET | /v1.1/agents | READ | |
| Generate SMTP short password | POST | /v1.1/agents/{agentkey}/short-passwords | CREATE | |
| List SMTP short password | GET | /v1.1/agents/{agentkey}/short-passwords | READ | |
| Delete SMTP short password | DELETE | /v1.1/agents/{agentkey}/short-passwords/{{id}} | DELETE | |
| Generate API keys | POST | /v1.1/agents/{agentkey}/apikeys | CREATE | |
| List API keys | GET | /v1.1/agents/{agentkey}/apikeys | READ | |
| Delete API keys | DELETE | /v1.1/agents/{agentkey}/apikeys/{{id}} | DELETE |
Email logs API
| Method name | Method type | URL | OAuth scope | Operation |
| Get all email logs | GET | /v1.1/email | Zeptomail.email.All | READ |
| Get specific email logs | GET | /v1.1/email/email-reference/{email-reference} | READ |
API error codes: The commonly intercepted errors while using APIs can be found here. This will help you better handle them.