API Documentation
Integrate email services using the MailPass API.
Base URL
https://dev.mailpass.im/api/v1
Authentication
All API requests must include an API key in the Authorization header.
Authorization: Bearer YOUR_API_KEYYou can generate an API key from Settings > API Keys.
OTP API
API for sending and verifying email verification codes
POST /otp/send
POST /otp/verify
Subscribers API
API for managing subscribers and lists
POST /subscribers
GET /subscribers
Campaigns API
API for creating and sending email campaigns
POST /campaigns
POST /campaigns/:id/send
Mail Send API
API for sending transactional emails (single/batch)
POST /mail/send
POST /mail/send-batch
Webhooks
Webhook configuration for receiving event notifications
email.opened
email.clicked
Bounces API
API for processing and querying email bounces
POST /bounces
GET /bounces
Response Format
All API responses are returned in JSON format.
Success Response
{
"success": true,
"data": { ... }
}Error Response
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The email field is required."
}
}Rate Limits
API requests are limited to 60 per minute. A 429 status code is returned when the rate limit is exceeded.