Skip to main content
POST
Start a campaign
Once started, the campaign status will change to running and messages will begin sending.

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}$

Response

Campaign started

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