Developer documentation

Build with the InboxIQ API

Get started

Authentication

Every API request identifies two things: who you are, with HTTP Basic authentication, and which application is sending, with the key header.

Credentials you need

CredentialWhere to find itHow it is sent
Username and passwordThe username and password you use to sign in to the InboxIQ dashboardAuthorization: Basic …
Application keyDashboard → Applications → your applicationkey: …

Request headers

Join your username and password with a colon, encode the result in Base64 and send it in the Authorization header. Most HTTP libraries do this for you when you give them a username and password.

HTTP
POST /api/v1/send-sms HTTP/1.1
Host: api.inboxiq.co.zw
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
key: YOUR_API_KEY
Content-Type: application/json

Encoding the Basic token

const token = btoa('username:password');

Applications and sender IDs

The application key decides how your messages are sent:

  • SMS sender ID. Messages use the application's approved sender ID, or the InboxIQ default until one is approved. You do not send a sender ID in the request.
  • Email sender. Emails come from the application's email sender name at inboxiq.co.zw. You can set the display name per email with personalName.
  • Reporting. Messages are counted against the application and shown in its history in the dashboard.

Create one application per system so you can tell their traffic apart and change one key without affecting the others.

Authentication errors

StatusCause
401 UnauthorizedThe Basic credentials are missing or wrong.
404 Not FoundThe key header is missing or does not match one of your applications.
Invalid key · 404
{
"timestamp": "2026-11-06T12:32:10.512Z",
"status": 404,
"error": [
"Invalid api access key supplied"
],
"path": "uri=/api/v1/send-sms",
"message": "Invalid api access key supplied"
}

Keeping credentials safe

  • Call the API from your server only. Never put your password or key in browser code or a mobile app.
  • Store them in environment variables or a secrets manager, not in source control.
  • If a key may have leaked, create a new application, switch your system to it and stop using the old one.
  • Change your dashboard password if you think it has been exposed. Your integration uses it too, so update it there at the same time.