PEPINO ZAPdocs
Referência da APICampanhas

Dispara (inicia) uma campanha

Ver como Markdown
POST
/v1/campaigns/{id}/start

Inicia o disparo de uma campanha em rascunho (DRAFT) ou agendada (SCHEDULED). ASSINCRONO: responde 202 imediatamente; a engine de cadencia passa a enviar respeitando warmup, janela horaria, ritmo com jitter, auto-pausa e validacao de numero. Acompanhe via GET /v1/campaigns/{id} e pelo evento campaign.status. GATING DUPLO: disparar exige a CONTA com assinatura ATIVA E o add-on "Disparo em massa" (402 sem isso, em producao; no modo teste e liberado). AVISO CRITICO: disparo em massa pode resultar em BANIMENTO do numero pela Meta; use listas com opt-in, mensagens nao-spam e volume moderado — o risco e do titular da conta.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Path Parameters

id*string

Identificador da campanha a disparar (precisa estar em DRAFT ou SCHEDULED).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/campaigns/string/start"
{
  "started": true
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Body invalido"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "PAYMENT_REQUIRED",
    "message": "E necessario um plano ativo para usar este recurso. Assine em \"Meu plano\"."
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "limite de numeros do plano atingido — adicione um numero em \"Meu plano\""
  }
}