Skip to main content
POST
Append a batch of recipients to a campaign by ID.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Body

application/json
recipients
object[]
required
Maximum array length: 5000
reset
boolean
default:false

Delete all recipients currently stored on the campaign before inserting this batch. Send it with the first batch to restart an upload from scratch.

is_last
boolean
default:false

Marks the final batch of an upload. Finalizes the upload, writes a campaign log entry and returns the campaign instead of the batch result.

Response

200 - application/json

Success. Intermediate batches return the result of the batch. The final batch ("is_last" = true) returns the campaign itself with the batch result in "meta".

data
object