API Endpoints

A reference map of the public, versioned REST API at /api/v1. For authentication details, request/response envelopes, and a full worked example, see the REST API page. For the exact, always-current contract, use the generated OpenAPI reference served inside your install at /developers/docs.

Auth in one line. Every request carries a workspace key (wsk_…) as Authorization: Bearer or X-Api-Key, and is scoped to that one workspace.

Messaging

Endpoint	Does
`POST /messages`	Send a message (text / location) to a number.
`GET /messages`	List messages.
`GET /messages/{id}`	Read one message and its delivery status.

Broadcasts, Campaigns & Scheduled

Endpoint	Does
`GET/POST /broadcasts`	List / create one-off bulk sends.
`GET /broadcasts/{id}`, `/recipients`, `/stop`	Read a broadcast, its per-recipient status, or stop it.
`GET/POST /campaigns`	List / create managed campaigns.
`GET /campaigns/{id}`, `/statistics`, `/stop`, `DELETE`	Read a campaign, its stats, stop it, or delete it.
`POST /scheduled`	Queue a send for a future time.

CRM & Pipeline

Endpoint	Does
`GET/POST /contacts`, `GET/PUT/DELETE /contacts/{id}`	Manage contact records.
`GET/POST /contact-groups`	Manage segments.
`GET/POST /deals`, `GET/PUT/DELETE /deals/{id}`	Sales pipeline; advance a stage by updating `stage_id`.

Flows, Templates & Auto-replies

Endpoint	Does
`GET /flows`, `GET /flows/{id}`	Read chatbot flows.
`POST /flows/{id}/enroll`, `/subscribers`	Enroll a contact into a flow; list subscribers.
`GET/POST /templates` (+ per-id)	Manage message templates.
`GET/POST /auto-replies` (+ per-id)	Manage keyword / auto-responder rules.

Devices, Account & Webhooks

Endpoint	Does
`GET /devices`, `GET /devices/{id}`	List connected senders and their status.
`GET /me`	Read the current workspace / key context.
Event webhooks	Receive inbound & delivery events on your server — see Third-Party Integrations and Webhooks.

Status codes

Code	Meaning
`200 / 201`	Success.
`401`	Missing or expired API key.
`403`	The plan feature for this endpoint is off.
`422`	Validation error — the body names the offending field.
`429`	Rate limit hit (limits are tiered by plan).