Skip to main content
POST
Add recipients

Authorizations

X-API-KEY
string
header
required

Path Parameters

campaign_id
string
required

Body

application/json
phone_number
string

E.164. Alias: phone. (mobile and number are accepted only by the CSV/XLSX /recipients/import endpoint, not this JSON endpoint.)

variables
object

Per-recipient values for prompt placeholders.

next_action_at
string<date-time>

Engine-managed scheduling state (reflects when the recipient is next due for an attempt, and is returned on the recipient object). Accepted here for forward-compatibility but NOT currently used to schedule the first contact — the campaign engine recomputes it from schedule.business_hours, so setting it does not defer the first dial. To control timing, use the campaign schedule.

recipients
object[]

Batch form: a list of recipient objects.

Response

Upserted recipients (numbers masked)