Pular para o conteúdo principal
POST
Criar uma campanha

Autorizações

Authorization
string
header
obrigatório

Autentique com uma chave secreta (sk_live_…) criada no painel.

Parâmetros de caminho

phone_number
string
obrigatório
Pattern: ^pn_

Corpo

application/json
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. Mensagens reaction não são permitidas em campanhas.

recipients
object
obrigatório

Exatamente um entre contacts e to.

throttle
object

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

Resposta

A nova campanha em rascunho.

id
string
obrigatório
Pattern: ^bcast_
Exemplo:

"bcast_9c2M"

object
string
obrigatório
Allowed value: "broadcast"
phone_number
string
obrigatório
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. Mensagens reaction não são permitidas em campanhas.

recipients
object
obrigatório

Exatamente um entre 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