Skip to main content
POST
Add recipients to an existing campaign, as many times as you like. Send a CSV, or a JSON list from your own system (for example new leads from your CRM). New numbers are called after the ones already waiting, with the campaign’s agent, phone line, calling windows, retries and variable mapping.
  • Scheduled, running and paused campaigns take the new numbers as they are. A paused campaign stays paused.
  • A completed campaign restarts to call them: it goes back to running, or scheduled when its start time is still ahead. It only restarts when at least one new number is added.
  • A cancelled campaign is refused with 409.
  • A number the campaign already has is left as it is: it is not called again and its status does not change. It is counted in already_in_campaign.
  • Numbers on your do-not-call list and invalid rows are stored as skipped, as at create.
Use Preview campaign add first to see what a file would do.

Request

Headers

string
required
Bearer token with your API key (scope agents)
string
required
application/json
string
1 to 128 printable characters without spaces. Send the same key again with the same body and you get the first result back, without anything being added twice. The same key with a different body is refused with 409. Keys are per campaign

Path

string
required
The campaign id

Body

Send exactly one of csv_text or recipients.
string
A CSV in the same format as at create. Up to 5 MB and 20,000 rows. See CSV format
object[]
1 to 20,000 people.
The campaign’s variable mapping and defaults apply to the new rows. A column the campaign maps does not have to be in a later file: its default is used.

Response

201 Created (or 200 OK when an Idempotency-Key replays the first result)

Errors

Example