SendAfricaAPI Overview
Base URL, conventions, the response envelope, and a map of every /v1 endpoint group in the SendAfrica REST API.
| Base URL | https://api.sendafrica.online |
| Protocol | HTTPS only |
| Format | application/json (CSV export/import and provider webhooks excepted) |
| Versioning | All routes mounted under /v1 (except /health) |
#Endpoint map
| Group | Prefix | Auth | Covers |
|---|---|---|---|
| Auth & accounts | /v1/auth/... | Public + JWT | Register, login, JWT refresh, OTP, OAuth, API keys |
| SMS | /v1/sms/... | API Key / JWT | Single & bulk send, message logs, callbacks |
| Contact lists | /v1/contact-lists/... | JWT | Phonebook CRUD, CSV import/export, Google sync |
| Campaigns | /v1/campaigns/... | JWT | Scheduled bulk sends with live stats |
| Credits | /v1/credits/... | JWT or API Key | Balance + transaction ledger |
| Payments | /v1/payments/... | JWT or API Key | Fixed-package top-ups via mobile money |
| Vouchers | /v1/vouchers/... | JWT or API Key | Pay-as-you-go top-ups for any amount |
| Notifications | /v1/notifications/... | JWT | In-app alerts: balance, payments, announcements |
| Rates | /v1/rates/... | Public | International country rate card |
| Packages / templates | /v1/packages, /v1/templates | Public | Pricing page + compose-UI data |
#Health check
GET
/healthPublicbash
bash
curl -s https://api.sendafrica.online/health
# { "status": "ok" }