Developer documentation

Build with the InboxIQ API

Email

Send an email

Send transactional email such as receipts, statements and notifications to one or more recipients.

POST/api/v1/send-email

Request

toRecipientsarray of stringsRequired

The email addresses to send to. Each must be a valid address. Every recipient receives their own copy.

subjectstringRequired

The subject line.

bodystringRequired

The content of the email, as HTML or plain text.

plainTextboolean

Set to true to send the body as plain text. Defaults to false, which sends HTML.

personalNamestring

The display name recipients see next to the sender address, for example "Northgate Billing".

attachmentsarray of objects

Files to attach. Each item has a name and a fileSourceUrl.

attachments[ ].namestring

The file name the recipient sees, for example invoice-5120.pdf.

attachments[ ].fileSourceUrlstring

A URL InboxIQ can download the file from when it sends the email.

curl -X POST https://api.inboxiq.co.zw/api/v1/send-email \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"toRecipients": [
"customer@example.com"
],
"subject": "Your receipt for order #5120",
"body": "<h1>Thank you for your payment</h1><p>We received USD 42.00 for order #5120.</p>",
"personalName": "YourStore",
"attachments": [
{
"name": "receipt-5120.pdf",
"fileSourceUrl": "https://yourstore.co.zw/receipts/5120.pdf"
}
]
}'

Response

A 200 OK response means the email was accepted and queued. InboxIQ sends it to each recipient in the background.

Response · 200 OK
{
"message": "Email has been queued for processing"
}

Sender address

Emails are sent from your application's email sender at inboxiq.co.zw. You set the sender name on the application in the dashboard, and you can change the display name per email with personalName.

HTML and plain text

  • By default the body is treated as HTML. Use inline styles, as many email apps ignore style sheets.
  • Set plainText to true for simple text emails.
  • Keep images on a public URL and reference them with <img src="https://…">.

Attachments

Give each attachment a file name and a URL InboxIQ can download it from at sending time. The URL must be reachable from the internet without logging in. Use a link that stays valid for at least a few minutes after you call the API.

Credits

Each recipient uses one email from your package. If your package does not have enough emails left, the request fails with 400 Bad Request and nothing is sent:

Not enough credit · 400
{
"timestamp": "2026-11-06T12:32:10.512Z",
"status": 400,
"error": [
"You do not have enough credit to send 3 email(s), please contact your account manager to recharge"
],
"path": "uri=/api/v1/send-email",
"message": "You do not have enough credit to send 3 email(s), please contact your account manager to recharge"
}

Check your remaining emails or upgrade your package from Credits & Plans in the dashboard.