Recipients

Add the customers a campaign will message, and see who's on the list.

Add the customers a campaign will message, and see who's on the list.

Upload recipients as a spreadsheet: name, email, phone, and any fields your templates use. Each row becomes one recipient. Uploading the same contact twice doesn't send twice.

You'll need the campaign_id.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Upload recipients

POST — Add customers to a campaign from a spreadsheet.

Open →

List recipients

GET — See who's on a campaign's list and the status of each: pending, sent, clicked, unsubscribed.

Open →


Did this page help you?