Skip to main content
POST
Criar campanha

Autorizações

Authorization
string
header
obrigatório

Authorization: Bearer sk_live_xxxxx

Corpo

application/json

templateId obrigatório. channels ⊆ enabledChannels do template (whatsapp, sms, email, telegram). Com scheduledFor (≥ ~2 min), status inicial SCHEDULED. Sending Pool WhatsApp: configure no painel (a API v1 de create ainda não envia sendingPoolId).

name
string
obrigatório
Maximum string length: 128
templateId
string
obrigatório

Template cujo conjunto de canais habilitados restringe channels.

Minimum string length: 1
channels
enum<string>[]
obrigatório
Minimum array length: 1

Canal na campanha (create/update): whatsapp, sms, email, telegram, push, rcs, instagram. Deve ser subconjunto dos canais habilitados no template.

Opções disponíveis:
whatsapp,
sms,
email,
telegram,
push,
rcs,
instagram
segmentId
string
audienceContactIds
string[]

Lista fixa de contatos (máx. 10.000). Mutuamente exclusivo com segmentId.

Maximum array length: 10000
scheduledFor
string<date-time>

ISO-8601. Mínimo ~2 minutos no futuro → 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
channelFailureMode
enum<string>
padrão:STRICT

Modo de falha por canal. Padrão STRICT.

Opções disponíveis:
STRICT,
PARTIAL,
strict,
partial,
pessimistic,
optimistic,
best_effort
variables
object

Mesclado por cima das propriedades do contato no render do template.

sendingPoolId
string | null

Sending Pool WhatsApp (alternativa a instanceId quando whatsapp ∈ channels).

Resposta

Criada.

success
boolean
data
object

Campanha multicanal. channels ⊆ canais habilitados do template (whatsapp|sms|email|telegram). Status: DRAFT, SCHEDULED, RUNNING, COMPLETED, FAILED, CANCELLED.

Exemplo: