Skip to main content
POST
Create campaign

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_live_xxxxx

Body

application/json

templateId required. channels ⊆ template enabledChannels (whatsapp, sms, email, telegram). With scheduledFor (≥ ~2 min), initial status SCHEDULED. WhatsApp Sending Pool: configure in the dashboard (v1 create API does not yet accept sendingPoolId).

name
string
required
Maximum string length: 128
templateId
string
required

Template cujo conjunto de canais habilitados restringe channels.

Minimum string length: 1
channels
enum<string>[]
required
Minimum array length: 1

Campaign channel (create/update): whatsapp, sms, email, telegram. Must be a subset of channels enabled on the template. Templates may enable RCS/Push/voice; campaign create via API/dashboard uses these four.

Available options:
whatsapp,
sms,
email,
telegram
segmentId
string
audienceContactIds
string[]
scheduledFor
string<date-time>

ISO-8601. At least ~2 minutes ahead → status SCHEDULED.

instanceId
string | null

Instância WhatsApp (obrigatória na prática se incluir whatsapp e não houver padrão no workspace).

telegramInstanceId
string | null

Instância Telegram (obrigatória na prática se incluir telegram e não houver padrão no workspace).

fromEmail
string | null
variables
object

Merged on top of contact properties when rendering the template.

Response

Criada.

success
boolean
data
object

Multichannel campaign. channels ⊆ template enabled channels (whatsapp|sms|email|telegram). Status: DRAFT, SCHEDULED, RUNNING, COMPLETED, FAILED, CANCELLED.