Skip to main content
POST
Create campaign

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
from
string
required
template_id
string<uuid>

Response

Campaign created successfully

id
string<uuid>
tenant_id
string<uuid>
account_id
string<uuid>
name
string
template_id
string<uuid>
sender_id
string
status
enum<string>
Available options:
draft,
running,
paused,
completed,
cancelled
total_recipients
integer
sent_count
integer
failed_count
integer
started_at
string<date-time>
completed_at
string<date-time>
created_at
string<date-time>
updated_at
string<date-time>