Campanhas

Crie e gerencie campanhas de marketing e broadcast para enviar mensagens em massa para contatos segmentados via WhatsApp, email ou outros canais.

Tipos de Campanha

Campanhas podem ser one-off (envio unico) ou ongoing (campanhas continuas ativadas por triggers como visita ao site ou evento).

Listar Campanhas

GET/api/v1/accounts/{account_id}/campaigns

Lista todas as campanhas da conta.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/campaigns" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de campanhas

json

{
  "data": [
    {
      "id": 1,
      "title": "Promocao de Janeiro",
      "description": "Ofertas especiais para clientes ativos",
      "campaign_type": "one_off",
      "inbox": { "id": 1, "name": "WhatsApp Business" },
      "scheduled_at": "2026-02-01T09:00:00Z",
      "audience": [
        { "type": "label", "id": "clientes-ativos" }
      ],
      "message": "Ola {{contact.name}}! Temos ofertas especiais para voce este mes.",
      "enabled": true,
      "campaign_status": "completed",
      "created_at": "2026-01-25T10:00:00Z"
    }
  ]
}

POST/api/v1/accounts/{account_id}/campaigns

Cria uma nova campanha.

Body

Nome	Tipo	Obrigatorio	Descricao
`title`	`string`	Sim	Titulo da campanha
`description`	`string`	Nao	Descricao
`campaign_type`	`string`	Sim	one_off ou ongoing
`inbox_id`	`integer`	Sim	ID da inbox de envio
`message`	`string`	Sim	Mensagem (suporta variaveis {{contact.name}}, etc.)
`scheduled_at`	`string`	Nao	Data de envio (ISO 8601) — para one_off
`audience`	`array`	Nao	Segmentacao: labels, filtros ou lista de contatos
`enabled`	`boolean`	Nao	Campanha ativa(default: `true`)

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/campaigns" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Boas-vindas novos contatos",
    "campaign_type": "ongoing",
    "inbox_id": 1,
    "message": "Ola {{contact.name}}! Bem-vindo a nossa comunidade.",
    "audience": [{ "type": "label", "id": "novos" }]
  }'

GET/api/v1/accounts/{account_id}/campaigns/{id}

Retorna detalhes de uma campanha com metricas de envio.

PATCH/api/v1/accounts/{account_id}/campaigns/{id}

Atualiza uma campanha.

Body

Nome	Tipo	Obrigatorio	Descricao
`title`	`string`	Nao	Titulo
`message`	`string`	Nao	Mensagem
`enabled`	`boolean`	Nao	Ativar/desativar
`scheduled_at`	`string`	Nao	Reagendar

DELETE/api/v1/accounts/{account_id}/campaigns/{id}

Remove uma campanha.