Base URL
/api/public.
Conventions
- REST + JSON. Send and receive
application/json. - Uniform envelope. Every response is
{ "ok": true, ... }on success or{ "ok": false, "error": "..." }with a4xx/5xxstatus on failure. - Tenant-scoped. A key only ever sees its own workspace’s data.
- IDs are UUIDs. Pass the ids returned by list endpoints.
Get started
Authentication
Create an API key and authenticate your requests.
Quickstart
Import a contact and launch your first campaign in a few calls.
What you can build
Every part of the platform is available through the API. Here’s the map.Audience
Contacts
Create, update, and organize the people you reach.
Lists & segments
Static lists and live, rule-based segments.
Suppression
Keep specific numbers off your sends.
Engage
Campaigns
SMS & voice campaigns to a list, with timed follow-ups.
Messages & calls
Send a single SMS or place an outbound voice-agent call.
Inbox
Read conversations and reply in-thread.
Agents
AI SMS & voice agents that hold the conversation for you.
Automate
Flows
Multi-step journeys — send, wait, branch, call, tag, integrate.
Offers
Track destinations and attribute conversions back to sends.
Deploy
Phone numbers
Search, order, release, and pool your sending numbers.
Registration
10DLC brands & campaigns, plus short-code requests.
Measure & connect
Analytics
Delivery, engagement, conversions, and custom reports.
Webhooks
Subscribe to events — replies, clicks, opt-outs, call outcomes.
Creating or starting a campaign, sending a message, and placing a call dispatch
real traffic and may incur cost. Test against a small list first.