Documentation menu

Run calls

Campaigns & leads

A lead is who gets called. A campaign is the list of leads an agent works through, one call at a time.

Leads

A lead is a name, phone number, and optionally an email and any custom fields you need — a plan tier, an account id, whatever the agent should be able to reference with a merge field or hand to a tool. Add leads one at a time, paste a CSV, or connect a Google Sheet and keep it synced.

Note
Custom fields are discovered automatically from whatever you’ve imported — there’s no schema to declare up front.

Campaigns

A campaign is an agent plus a list of leads. Starting it dials down the list at a controlled pace; stopping it leaves whatever hasn’t been reached yet untouched, so it can be resumed later rather than starting over. A campaign reports itself completed once every lead has reached a terminal call outcome (answered, no-answer, busy, failed, or cancelled).

  • POST /api/campaigns/start with { id } begins dialling.
  • POST /api/campaigns/stop with { id } pauses it.
  • Per-account plan limits cap how many campaigns and calls can run at once — see the API reference for the exact response when a limit is hit.

A single call, outside a campaign

Not every call needs a campaign around it — dialling one lead directly, or answering an inbound call to a number pointed at an agent, both work the same way with no list involved.

PreviousKnowledge baseNextCalls & recordings