Marketing API Overview
The Marketing API allows you to retrieve campaign data and monitor marketing performance programmatically.
Access your email and SMS campaign records from external analytics platforms, business intelligence tools, or reporting dashboards. The Marketing API provides visibility into your campaigns without interfering with your sending workflows.
What You Can Build
- Analytics Dashboards: Visualize campaign performance across open rates, clicks, and conversions
- BI Integrations: Pull campaign data into your data warehouse or reporting tools
- CRM Sync: Correlate campaign engagement with customer records in external systems
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /business/campaign/list | List all campaigns |
GET | /business/campaign/details/:id | Get campaign details |
POST | /business/list/create | Create a contact list |
GET | /business/list/list | List all contact lists |
GET | /business/list/details/:id | Get list details |
POST | /business/list/:id/contact/add | Add a contact to a list |
Campaign Types
| Type | Description |
|---|---|
email | Email marketing campaign |
sms | SMS marketing campaign |
Campaign Statuses
| Status | Description |
|---|---|
draft | Campaign created but not yet sent |
scheduled | Queued for sending at a future time |
sending | Currently being sent |
sent | Campaign fully dispatched |
paused | Sending paused |
cancelled | Campaign cancelled |