Skip to main content
POST
Send a sample campaign
Sending a sample campaign does not modify the parent campaign. It’s a great way to test your template and parameters before a full broadcast.

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

Sample campaign created and started

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