Campanhas

Lista as Campanhas nesta organização, das mais recentes para as mais antigas. Campanhas MARKETING são envios em massa para segmentos ou todos os contactos; Campanhas TRANSACTIONAL são envios para um único destinatário acionados por gatilhos ou pela API.

Ler uma única campanha na íntegra: estado, agendamento, audiência (segmentos ou todos os contactos), modelos de canal e contadores de entrega (enviadas, entregues, abertas, falhadas).

Cria uma campanha como RASCUNHO: uma campanha de marketing em massa (ex.: envio em massa de modelo do WhatsApp) para segmentos ou todos os contactos, ou um envio transacional para um único destinatário.

Atualizar o nome, a hora de agendamento ou a audiência de uma campanha. A audiência e o agendamento só podem ser alterados enquanto a campanha for editável (marketing: RASCUNHO, CANCELADA ou FALHADA; transacional: RASCUNHO, ATIVA ou EM PAUSA).

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

Eliminar permanentemente uma campanha e o respetivo histórico de entrega. As campanhas de marketing não podem ser eliminadas enquanto estiverem agendadas ou em envio; as transacionais têm de ser colocadas em pausa primeiro.

Move uma campanha ao longo do seu ciclo de vida: 'schedule' coloca uma campanha de MARKETING em fila para toda a audiência (o envio em massa real — imediatamente ou na hora agendada; requer um modelo de canal); 'cancel' para uma campanha de marketing agendada/em envio e devolve-a a rascunho; 'activate' liga uma campanha TRANSACTIONAL; 'pause' suspende-a.

Anexa ou atualiza a mensagem do canal de uma Campanha — aquilo que é realmente enviado.

Adiciona contactos específicos à audiência de uma campanha de MARKETING (além de segmentos / enviar para todos), por exemplo uma lista importada de um ficheiro ou filtrada em código. Requer uma campanha editável com pelo menos um modelo de canal.

Pré-visualiza quantos destinatários uma campanha de MARKETING vai alcançar por canal, com base na audiência atual — verifica isto antes de agendar o envio.

Tenta novamente os destinatários falhados de uma campanha (até 1000 por chamada). Omite recipient_ids para voltar a tentar todos os falhados.

Remove destinatários pendentes (ainda não enviados) de uma campanha de MARKETING editável. Omite contact_ids para remover todos os pendentes.

Lista os campos de personalização (placeholders {{variable}}) de uma campanha com os respetivos valores predefinidos.

Cria ou atualiza um campo de personalização ({{variable}}) numa campanha com o respetivo valor predefinido. Chaves reservadas como first_name/last_name são resolvidas a partir do contacto; outras chaves usam o valor predefinido, a menos que uma entrada por destinatário o substitua.

Define valores de personalização por destinatário numa Campanha de MARKETING. Passa uma entrada por destinatário, identificado por email, telefone ou user_id. Passa dry_run para pré-visualizar que destinatários corresponderiam sem gravar nada.

Coloca uma campanha MARKETING na fila para envio ao público completo. Envia imediatamente quando a campanha não tem hora agendada; caso contrário, espera por essa hora. Este é o envio em massa real: confirma com o utilizador antes de o executar. Requer estado DRAFT, CANCELLED ou FAILED e pelo menos um modelo de canal.

Cancela uma campanha de MARKETING em estado SCHEDULED ou SENDING: volta para DRAFT e pode ser editada e agendada novamente. Os destinatários já enviados continuam enviados.

Ativar uma campanha TRANSACIONAL para que aceite gatilhos e comece a enviar para destinatários individuais. Permitido a partir de RASCUNHO ou EM PAUSA; requer pelo menos um modelo de canal.

Pausar uma campanha transacional ATIVA. Os gatilhos são rejeitados até ser ativada novamente; a configuração é preservada.

Enviar um teste de uma campanha para um único endereço de e-mail ou número de telefone, para que o seu conteúdo possa ser revisto antes do envio real. Só funciona enquanto a campanha estiver em estado de teste (marketing: RASCUNHO, CANCELADA ou FALHADA; transacional: RASCUNHO, ATIVA ou EM PAUSA).

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

Lista entregas individuais de campanhas com o respetivo estado (sent, delivered, opened, failed, bounced). Responde a "enviámos X para este contacto?": filtra por campanha, por contacto, ou pesquisa por nome, email ou telefone em todas as campanhas.