Criar uma campanha oficial

Cria uma campanha com um modelo aprovado e os contatos de uma de duas formas. phoneNumbers (como sempre): cada item vira um lead, casado pelo número (só dígitos, com o código do país 55, como 5584999990002) ou criado com origem importação, e uma entrada com variables e metadata. recipients (o passo de público, sem phoneNumbers): source: list com o listId de POST /campaign-audience/whatsapp/lists, que vira as mesmas entradas, com as colunas ligadas às variáveis e as células vazias de variável com campo sugerido preenchidas pelo lead (linha sem o valor recusa a criação com 422 audience_list_variables_missing); ou source: leads com a seleção (com expectedCount e fingerprint da contagem) e as variáveis ligadas a campos do lead, em que cada lead sem o valor precisa de missing: text (texto padrão) ou missing: exclude (entra como pulado com missing_variable), senão 422 audience_variable_choice_required. Com workflowId ou agentId, cada variável que o fluxo ou o agente pede vem do público como as do modelo (variables[] com key igual ao nome: um campo do lead, um texto fixo ou, numa lista, a coluna pelo cabeçalho em column), com a mesma escolha de missing; sem valor e sem escolha, 422 audience_variable_choice_required, e uma coluna que a lista não tem, 422 audience_list_column_unknown. A variável de agente com padrão é opcional. Os valores vão para os metadados da entrada. Leads bloqueados, sem número, com opt-out, no intervalo entre disparos ou em outra campanha em andamento entram pulados com o motivo. As variáveis seguem a ordem do envio, nas duas formas: a variável do texto do cabeçalho primeiro, depois as do corpo (nomeadas ou numeradas); no envio a do cabeçalho vai no cabeçalho e as do corpo no corpo, com o nome quando o modelo usa variáveis nomeadas. As ondas de smartPolicy valem para as duas formas. stageGroupId copia um modelo de etapas para o funil da campanha quando não há pipelineId. Com scheduledStart (RFC 3339; outro formato responde 400 campaign_schedule_invalid), a criação passa antes pela mesma verificação do Iniciar: um bloqueio responde 409 campaign_launch_blocked e riscos pedem confirmação com 409 campaign_launch_unconfirmed (reenvie com o confirmedFingerprint de details.fingerprint); em ambos nada é criado. A confirmação fica guardada com o agendamento e, 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. Agendar exige a permissão de iniciar campanhas (403 start_permission_required); criar sem agendamento exige só a de criar.

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

Campanha, com phoneNumbers ou recipients

string
string
string
string
string
boolean
boolean
boolean
boolean
boolean
boolean
string
phoneNumbers
array of objects
phoneNumbers
string
recipients
object
string
boolean
smartPolicy
object
string
string
string
string
Headers
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