Overview

The Altermail API lets you send transactional and marketing emails programmatically using your own verified domain. All requests are authenticated with your API key and responses follow standard HTTP status codes.

Base URLhttps://api.altermail-console.com.ng

Emails are dispatched asynchronously; the API returns 202 Accepted as soon as the request is validated and queued. Delivery happens in the background within seconds.

Stuck on something not covered here? You don’t need to leave your dashboard: open the Support section in your dashboard’s sidebar nav to message our team directly and track your tickets, right where you already are.

Getting Started

Authentication
Authenticate with the Altermail API using a per-account token header. How to find your API key and secure it.

Sending

Send Email
Send a transactional or marketing email with a single POST request to the Altermail email-sending endpoint.
Request Fields
Full reference of every field accepted by the Altermail send-email endpoint, required and optional.
Code Examples
Send email with Altermail using cURL, Node.js, Python, PHP, Go, C#, Java, or C++: copy-paste ready examples.
Sender Display Name
Set a custom display name for the From address on emails sent through the Altermail API.
CC, BCC & Reply-To
Add CC, BCC, and Reply-To recipients to emails sent via the Altermail REST API.
Attachments
Attach files to outbound email via the Altermail API: supported formats, size limits, and encoding.
Email Templates
Use Altermail's branded email templates and colour schemes, or send raw custom HTML.
Bulk Send
Send bulk email campaigns to up to 50,000 recipients per job with the Altermail bulk-send API.
Responses
Altermail API response formats and status codes for successful sends and errors.
Suppressions & Unsubscribes
Manage per-recipient marketing unsubscribes: list, add, or re-subscribe an address via the Altermail suppressions API.

Domains & Deliverability

Sender Domains
Verify a sending domain with Altermail via a DNS TXT record before sending email from it.
DKIM Signing
How Altermail signs outbound email with DKIM once your sender domain is verified.
SPF & DMARC
Recommended SPF and DMARC DNS records for domains sending email through Altermail.

Billing & Limits

Quota & Billing
How Altermail's monthly email quotas, daily limits, the 3-month free trial, PAYG credits, and Naira billing work.
Rate Limits
Altermail API rate limits per account and how to handle 429 responses.
Account Suspension
What triggers automatic account suspension on Altermail (bounce and complaint thresholds) and how to appeal.

Advanced

Delivery Events
Query sent, delivered, and bounced email events for your Altermail account via the events API.
SMTP Submission
Send email through Altermail via standard SMTP instead of the REST API: works with WordPress, PHPMailer, and any SMTP-compatible plugin or library.
Webhooks
Receive real-time delivery, bounce, and complaint webhook callbacks from Altermail, with HMAC signature verification.
Engagement Tracking
Track link clicks and approximate opens per sending domain, separately for marketing and transactional email, with opened/clicked webhook events.