Skip to main content
POST
Attach recipients to a campaign
This endpoint appends new recipients to the existing list.
  • Phone numbers already on the campaign are skipped.
  • Duplicates within the same request are deduplicated.
  • A campaign can have a maximum of 1000 recipients total. If appending would exceed this limit, a 400 error is returned.
  • If every number in your request already exists on the campaign, a 400 error is returned.

Authorizations

Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Path Parameters

_id
string
required

Campaign MongoDB id returned on create

Pattern: ^[a-fA-F0-9]{24}$

Body

application/json
recipients
object[]
required
Required array length: 1 - 1000 elements

Response

Recipients attached

success
enum<boolean>
required
Available options:
true
data
object
required