Concluir um rascunho: enviar agora, agendar ou deixar pronta

Um único pedido cria a campanha do rascunho e decide o início. mode: ready cria a campanha parada, pronta para iniciar quando quiser. mode: schedule roda antes a mesma verificação do mode: now sobre o rascunho (409 campaign_launch_blocked, ou 409 campaign_launch_unconfirmed e envie confirmedFingerprint; nada é criado nesses casos) e cria a campanha com scheduledStart, guardando a confirmação com o agendamento. No horário a campanha só inicia se os riscos ainda forem os mesmos; senão ela fica parada com scheduleFailure e quem agendou recebe uma notificação. Uma campanha não oficial nunca pede confirmação, só bloqueia. Agendar, como iniciar agora, exige a permissão de iniciar campanhas (403 start_permission_required); mode: ready exige só a de criar. mode: now exige a permissão de iniciar, roda antes a mesma verificação do Iniciar sobre o rascunho e, se ela bloqueia (409 campaign_launch_blocked) ou pede confirmação (409 campaign_launch_unconfirmed, envie confirmedFingerprint), nada é criado e o rascunho continua; senão cria, aplica as configurações do rascunho e inicia. Criada a campanha, o rascunho é apagado. Dois pedidos ao mesmo tempo nunca criam duas campanhas: enquanto um inicia, o outro responde 409 campaign_draft_launching. Se o início ainda recusar depois de criar, a resposta traz a campanha pronta com started: false e startRefusal. 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

whatsapp ou unofficial_whatsapp

string
required

ID do rascunho

Body Params

Como iniciar

string
string
enum
Allowed:
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

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

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

Responses

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