Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required
Required string length: 1 - 200
channel
enum<string>
required
Available options:
sms,
mms,
whatsapp,
email,
rcs,
viber,
voice,
instagram,
messenger,
line,
push,
telegram,
fax
description
string
Maximum string length: 1000
type
enum<string>
Available options:
blast,
drip,
journey
audience_type
enum<string>
Available options:
all,
list,
segment,
csv
audience_id
string
message_template
string
Maximum string length: 10000
variables
object
scheduled_at
string<date-time>
throttle_rate
integer
Required range: 0 <= x <= 1000
recurrence
object

Recurrence config. Accepts either canonical keys (type, end_type, end_date, end_count, days, date, cron) or UI-prefixed keys (recurrence_type, recurrence_end_type, recurrence_end_date, etc.). When end_type === 'on_date' the end_date MUST be in the future; past dates are rejected with HTTP 400.

business_hours_only
boolean
steps
object[]
Maximum array length: 50
smart_send
boolean
default:false

Response

Campaign created (draft state)

Campaign created (draft state)

data
object
meta
object