Sending email
One POST sends a message. Authenticate with an email API key and send from an address on a verified domain.
Authentication
Create an email API key in the dashboard's email section and send it as a Bearer token. Send keys are scoped to send-only; a full key can also manage domains and suppressions.
Send
curl -X POST https://api.orizon.ng/v1/emails \
-H "Authorization: Bearer orz_your_email_key" \
-H "Content-Type: application/json" \
-d '{
"from": "Acme <[email protected]>",
"to": ["[email protected]"],
"cc": [],
"reply_to": "[email protected]",
"subject": "Your receipt",
"html": "<p>Thanks for your order.</p>",
"text": "Thanks for your order."
}'Request fields
- from (required) —
Name <addr@domain>or a bare address. The domain must be verified for your team. - to (required) — a string or array of recipients; at least one must be valid.
- cc, bcc — optional, string or array.
- reply_to — optional, string or array.
- subject (required).
- html and/or text — at least one is required.
- headers — optional map of custom headers.
- tags — optional metadata object stored with the send.
Response
{
"id": "em_...",
"status": "sent",
"suppressed": [] // any recipients dropped for being on the suppression list
}Recipients on the suppression list are silently removed. If every
to recipient is suppressed, the request returns 422. Sends are rate-limited per key (10 per second by default).Endpoints
POST
/v1/emailsSend a transactional emailGET
/v1/emailsList recent sendsGET
/v1/emails/{id}Get a send + its event timeline