Introduction
The External API provides a simple, secure interface for sending WhatsApp template messages from your backend systems. It’s designed for server-to-server integrations where you need to programmatically send messages.
Use cases
Section titled “Use cases”Transactional messages
Order confirmations, shipping updates, appointment reminders
Notifications
Account alerts, payment receipts, service updates
Marketing campaigns
Promotional messages to opted-in customers
Automated workflows
Messages triggered by your business logic
API vs dashboard
Section titled “API vs dashboard”| Feature | Dashboard | External API |
|---|---|---|
| Authentication | Email/Password | API Keys |
| Use Case | Manual operations | Automated integrations |
| Message Types | All types | Template messages only |
| Bulk Sending | UI-based | Programmatic |
Base URL
Section titled “Base URL”API base URL
Available endpoints
Section titled “Available endpoints”| Method | Endpoint | Description |
|---|---|---|
| POST | /auth/verify | Verify API credentials |
| GET | /channels | List accessible channels |
| GET | /channels/:id | Get channel details |
| GET | /channels/:id/templates | List channel templates |
| GET | /channels/:id/templates/:id | Get template details |
| POST | /messages/send | Send single message |
| POST | /messages/bulk | Send bulk messages |
| GET | /messages/bulk/:id/status | Check bulk status |
Response format
Section titled “Response format”Success response
All successful responses follow this structure:
{ "success": true, "data": { ... }}Error response
All error responses include an error code and message:
{ "success": false, "error": { "code": "ERROR_CODE", "message": "Human-readable error description" }}Next steps
Section titled “Next steps”Ready to get started?
Follow the Quick Start Guide to send your first message.