Nyota SMS
REST API Reference
Complete HTTP endpoint reference for Nyota SMS.
All requests require authentication via the x-nyota-api-key header or a valid Bearer JWT. Mutating requests accept an optional x-idempotency-key header.
Endpoints
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
| POST | /v1/sms/send | Dispatch single or bulk SMS messages. | sms:send |
| GET | /v1/sms/logs | List message delivery logs and carrier statuses. | sms:wallet:read |
| POST | /v1/sms/campaigns | Create a scheduled or draft campaign. | sms:send |
| POST | /v1/sms/campaigns/estimate | Dry-run template compilation & unit cost estimation. | sms:send |
| GET | /v1/sms/campaigns | List campaigns with status and OU filtering. | sms:send |
| GET | /v1/sms/campaigns/:id | Fetch real-time progress of a specific campaign. | sms:send |
| POST | /v1/sms/campaigns/:id/approve | Approve a pending campaign for dispatch. | sms:send |
| POST | /v1/sms/campaigns/:id/pause | Pause an active or scheduled campaign. | sms:send |
| POST | /v1/sms/campaigns/:id/resume | Resume a paused campaign. | sms:send |
| POST | /v1/sms/campaigns/:id/cancel | Cancel a campaign and purge un-dispatched outbox items. | sms:send |
| POST | /v1/sms/contacts | Create or update a contact. | sms:contacts:write |
| GET | /v1/sms/contacts | List contacts with search and group filtering. | sms:contacts:read |
| DELETE | /v1/sms/contacts/:id | Delete a contact. | sms:contacts:write |
| POST | /v1/sms/contacts/import | Bulk import pre-parsed contacts (up to 5,000). | sms:contacts:write |
| POST | /v1/sms/groups | Create a contact group. | sms:contacts:write |
| GET | /v1/sms/groups | List contact groups with member counts. | sms:contacts:read |
| DELETE | /v1/sms/groups/:id | Delete a contact group. | sms:contacts:write |
| POST | /v1/sms/groups/:id/members | Add contacts to a group. | sms:contacts:write |
| DELETE | /v1/sms/groups/:id/members | Remove contacts from a group. | sms:contacts:write |
| POST | /v1/sms/senders | Submit a branded Sender ID application. | sms:sender_id:manage |
| GET | /v1/sms/senders | List registered Sender IDs and payment status. | sms:sender_id:manage |
| GET | /v1/sms/wallet | Fetch SMS unit balance and PAYG settings. | sms:wallet:read |
| PATCH | /v1/sms/wallet | Update PAYG auto-topup configuration. | sms:wallet:write |