Base URL
All v2 API requests should be made to:Authentication
Every request requires an API key in theX-Api-Key header:
trk_[32-char-alphanumeric]. See Authentication for details.
What’s New in V2
| Feature | V1 | V2 |
|---|---|---|
| Send messages | Single & bulk | Single, bulk, raw, raw bulk |
| Contacts | No-op stubs | Full CRUD + bulk + journey enrollment |
| Lists | Not available | Read-only list management |
| Creatives | Not available | Full CRUD with segment estimation |
| Audiences | Not available | Full CRUD with filter DSL + size calculation |
| Offers | Not available | Full CRUD with metadata |
| Schedules | Not available | Full CRUD with blast variants |
| Revenue | Not available | Attribution tracking, single & bulk |
| Data import | Not available | Import sends, clicks, revenue history |
| Webhooks | Delivery status only | Delivery, unsubscribe, reply events |
Request Format
- All requests must include
Content-Type: application/json - Phone numbers must be in E.164 format (e.g.,
+14155551234) - Request bodies must be valid JSON
- Maximum payload size: 5 MB
Response Format
All v2 responses use a consistent JSON structure.- Success (2xx)
- Error (4xx)
Pagination
Endpoints that return lists support pagination via query parameters:| Parameter | Default | Max | Description |
|---|---|---|---|
page | 1 | — | Page number |
per_page | 50 | 1000 (contacts) / 100 (others) | Items per page |
pagination object:
Bulk Operations
Bulk endpoints accept up to 1,000 records per request. Each record is processed individually — partial success is possible. Bulk responses include per-record error details:Available Endpoints
Messages
Send single and bulk SMS messages
Raw Messages
Send raw messages with skip options
Contacts
Create, list, and manage contacts
Lists
View sending lists and contact counts
Creatives
Manage message templates with offer links
Audiences
Build dynamic audience segments
Offers
Manage tracking offers and payouts
Schedules
Create and manage scheduled campaigns
Links
Create trackable short links for offers
Revenue
Record revenue attribution
Data Import
Import historical sends, clicks, and revenue
Webhooks
Receive delivery and reply events
Audience Filters
Build complex audience filter queries
Migration from V1
If you’re using the deprecated v1 API, see the Migration Guide for a field-by-field comparison and upgrade path.Next Steps
Send First SMS
Send your first message in 5 minutes
Authentication
Set up your API key