Skip to main content
PATCH
Atualizar campanha

Autorizações

Authorization
string
header
obrigatório

Authorization: Bearer sk_live_xxxxx

Parâmetros de caminho

campaignId
string
obrigatório

Corpo

application/json
name
string
Maximum string length: 128
templateId
string

Trocar o template da campanha (não use null para remover; a campanha sempre exige template).

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

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 | null
audienceContactIds
string[] | null
scheduledFor
string<date-time> | null
instanceId
string | null

Instância WhatsApp

telegramInstanceId
string | null

Instância Telegram

fromEmail
string | null
channelFailureMode
enum<string>

Modo de falha por canal.

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

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

Resposta

Atualizada.

success
boolean
data
object

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

Exemplo: