API documentation endpoint
Returns this documentation as markdown:
GET /api/email/docs
Error responses
All errors return JSON:
{
"success": false,
"message": "Error description"
}
Common status codes
| Code | Meaning |
|---|---|
| 400 | Missing or invalid request fields |
| 401 | Invalid or missing CRM token |
| 403 | Not authorized for this resource |
| 404 | Sender, contact, or group not found |
| 409 | Recipient suppressed (unsubscribed/bounced) or plan limit |
| 502 | Credit deduction failed |
Notes
- The sender domain must be verified before sending.
- Bulk sends deduct email credits from your account balance.
- Unsubscribed, bounced, and complained recipients are automatically filtered out of bulk sends.
- Marketing emails must include an unsubscribe link (auto-appended when enabled in Email settings).
- All sends are subject to tenant email health and abuse rate limits.
+1 302 486 0000
+61 2 5129 0955
+44 7828 573520