Upload recipients

Add customers to a campaign from a spreadsheet (CSV or Excel). The file is checked and stored straight away, then processed in the background; follow progress with List recipients. It accepts a draft campaign whose type is unset or already bulk_upload, and sets the type to bulk_upload; it won't switch a kiosk or automation campaign.

Prerequisites: a bearer token, a draft campaign whose type is unset or bulk_upload, and a CSV or Excel file up to 10 MB with an Email or Cell Phone column.

Authentication: Partner or Account token. The campaign's location must be inside your own account tree; otherwise 403.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Defaults to 4824

Required. The campaign to load recipients into. Digits only.

Body Params
file
required

The recipient list: .csv, .xlsx or .xls, up to 10 MB. The header row needs an Email or a Cell Phone column (any case); Customer Name, Requestor Name and Company are optional. A missing, too-large or wrong-type file is 422; a header row without Email or Cell Phone is 400.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json