Pular para o conteúdo principal
POST
Criar uma campanha

Autorizações

Authorization
string
header
obrigatório

Autentique com uma chave secreta (sk_live_…) ou uma chave restrita (rk_live_…) criada no painel. Chaves restritas só têm as permissões escolhidas na criação, como messages:send, chats:read ou broadcasts:send.

Cabeçalhos

Idempotency-Key
string

Uma chave única, como um UUID, que torna seguro repetir esta requisição por 24 horas.

Maximum string length: 255
Blu-Version
string

A versão da API a usar. Por padrão, é a versão fixada na sua conta.

Exemplo:

"2026-10-11"

Corpo

application/json
phone_number
string
obrigatório
Pattern: ^pn_
message
object
obrigatório

A mensagem enviada a cada destinatário. Textos e legendas podem usar parâmetros nomeados, como {{name}}, preenchidos com os parameters de cada destinatário ou, no caso de contatos, com profile.name e metadata. Mensagens reaction não são permitidas em campanhas.

recipients
object
obrigatório

Exatamente um entre label, contacts e to.

throttle
object

Intervalos entre as mensagens, para proteger o número.

metadata
object

Até 50 pares de chave e valor seus. Chaves com até 40 caracteres e valores com até 500.

Resposta

A nova campanha em rascunho.

id
string
obrigatório
Pattern: ^bcast_
Exemplo:

"bcast_9c2M"

object
string
obrigatório
Allowed value: "broadcast"
phone_number
obrigatório

Expansível.

Pattern: ^pn_
status
enum<string>
obrigatório
Opções disponíveis:
draft,
sending,
completed,
failed
message
object
obrigatório

A mensagem enviada a cada destinatário. Textos e legendas podem usar parâmetros nomeados, como {{name}}, preenchidos com os parameters de cada destinatário ou, no caso de contatos, com profile.name e metadata. Mensagens reaction não são permitidas em campanhas.

recipients
object
obrigatório

Exatamente um entre label, contacts e to.

throttle
object
obrigatório

Intervalos entre as mensagens, para proteger o número.

stats
object
obrigatório
estimated_cost
object | null
obrigatório

O valor que a Meta vai cobrar. Nulo enquanto a estimativa não está disponível.

failure_reason
string | null
obrigatório

Por que uma campanha failed parou.

sent_at
integer | null
obrigatório
completed_at
integer | null
obrigatório
created
integer
obrigatório

Horário Unix em segundos.

Exemplo:

1760190012

metadata
object
obrigatório

Até 50 pares de chave e valor seus. Chaves com até 40 caracteres e valores com até 500.