Campanhas

Liste as campanhas desta organização, da mais recente para a mais antiga. Campanhas de MARKETING são envios em massa para segmentos ou todos os contatos; campanhas TRANSACTIONAL são envios para um único destinatário disparados por gatilhos ou pela API.

Leia uma única campanha completa: status, agendamento, público (segmentos ou todos os contatos), modelos de canal e contadores de entrega (enviadas, entregues, abertas, com falha).

Crie uma campanha como RASCUNHO: uma campanha de marketing em massa (ex.: disparo de template no WhatsApp) para segmentos ou todos os contatos, ou um envio transacional para um único destinatário.

Atualize o nome, horário de agendamento ou público de uma campanha. Público e agendamento só podem ser alterados enquanto a campanha for editável (marketing: RASCUNHO, CANCELADA ou FALHA; transacional: RASCUNHO, ATIVA ou PAUSADA).

Copie uma campanha, incluindo seus segmentos e modelos de canal. A cópia é criada como RASCUNHO e não envia nada.

Exclua permanentemente uma campanha e seu histórico de entregas. Campanhas de marketing não podem ser excluídas enquanto estiverem agendadas ou em envio; as transacionais devem ser pausadas primeiro.

Mova uma Campanha pelo seu ciclo de vida: 'schedule' coloca uma Campanha MARKETING na fila para todo o público (o envio em massa real — imediatamente ou no horário agendado; exige um modelo de canal); 'cancel' para uma Campanha de marketing agendada/em envio e a devolve para rascunho; 'activate' ativa uma Campanha TRANSACTIONAL; 'pause' a pausa.

Anexe ou atualize a mensagem do canal de uma campanha — o que realmente será enviado.

Adicione contatos específicos ao público de uma Campanha MARKETING (além de segmentos / enviar para todos), por exemplo uma lista importada de arquivo ou filtrada no código. Exige uma Campanha editável com pelo menos um modelo de canal.

Veja quantos destinatários uma Campanha MARKETING alcançará por canal, com base no público atual — confira isso antes de agendar o envio.

Tente de novo os destinatários com falha de uma Campanha (até 1000 por chamada). Omita recipient_ids para tentar todos os que falharam.

Remova destinatários pendentes (ainda não enviados) de uma Campanha MARKETING editável. Omita contact_ids para remover todos os pendentes.

Liste os campos de personalização (placeholders {{variable}}) de uma Campanha com seus valores padrão.

Crie ou atualize um campo de personalização ({{variable}}) em uma Campanha com seu valor padrão. Chaves reservadas como first_name/last_name são resolvidas a partir do contato; outras chaves usam o padrão, a menos que uma entrada por destinatário substitua.

Defina valores de personalização por destinatário em uma Campanha de MARKETING. Passe uma entrada por destinatário, identificado por e-mail, telefone ou user_id. Passe dry_run para ver quais destinatários corresponderiam sem gravar nada.

Coloque uma campanha de MARKETING na fila para entrega ao seu público completo. Envia imediatamente quando a campanha não tem horário agendado; caso contrário, aguarda esse horário. Este é o envio em massa real: confirme com o usuário antes de executá-lo. Requer status RASCUNHO, CANCELADA ou FALHA e pelo menos um modelo de canal.

Cancele uma Campanha MARKETING com status SCHEDULED ou SENDING: ela volta para DRAFT e pode ser editada e agendada de novo. Destinatários já enviados continuam enviados.

Ative uma campanha TRANSACTIONAL para que aceite gatilhos e comece a enviar para destinatários individuais. Permitido a partir de RASCUNHO ou PAUSADA; requer pelo menos um modelo de canal.

Pause uma campanha transacional ATIVA. Os gatilhos são rejeitados até que ela seja ativada novamente; a configuração é preservada.

Envie um teste de uma campanha para um único endereço de e-mail ou número de telefone para que seu conteúdo possa ser revisado antes do envio real. Só funciona enquanto a campanha puder ser testada (marketing: RASCUNHO, CANCELADA ou FALHA; transacional: RASCUNHO, ATIVA ou PAUSADA).

Estatísticas agregadas de entrega e engajamento por campanha: totais, taxa de entrega e taxa de abertura, opcionalmente limitadas a um intervalo de datas.

Liste entregas individuais da campanha com seu status (enviada, entregue, aberta, com falha, rejeitada). Responde à pergunta "enviamos X para este contato?": filtre por campanha, por contato ou pesquise por nome, e-mail ou telefone em todas as campanhas.