Iniciar uma campanha oficial

Coloca a campanha id do workspace do cabeçalho X-Workspace-ID para enviar; a resposta 202 diz que o envio foi aceito e segue em segundo plano. Uma campanha preparada a partir de leads (origem lead_selection), parada, só começa pela revisão (POST /v1/leads/actions/sends/start), que pula quem entrou em outra campanha em andamento e confere saldo e limite mensal: por aqui responde 409 send_start_from_leads. Pausada, ela retoma por aqui. O mesmo vale para o início agendado e para as ferramentas do assistente. Todo início passa pela verificação de GET /whatsapp/campaigns/{id}/launch-check: um bloqueio responde 409 campaign_launch_blocked; riscos sem a confirmação atual respondem 409 campaign_launch_unconfirmed, com details.blocks, details.confirms, details.fingerprint e details.findings, e o início é aceito quando confirmedFingerprint traz o fingerprint mais recente. Uma onda bloqueada por um sinal de saúde responde 409 smart_campaign_blocked com as regras em details.reasons. Sem assinatura ativa, 402 subscription_inactive. Exige whatsapp_campaigns:start. Exige o cabeçalho Idempotency-Key (400 idempotency_key_required ou idempotency_key_invalid): repetir a mesma chave com o mesmo corpo devolve a primeira resposta com Idempotent-Replayed: true sem refazer nada; enquanto a primeira ainda roda, responde 409 idempotency_in_progress (repita em instantes); com outro corpo, 422 idempotency_key_reused; sem como conferir a chave, 503 idempotency_unavailable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Campanha

Body Params

Confirmação dos riscos da verificação de início

string
Headers
string
required

Chave gerada uma vez por pedido; repetir a mesma chave devolve a mesma resposta sem enviar nem cobrar de novo

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json