Como configurar e gerenciar campanhas via API da Snov.io

Este guia explica como configurar sequências de campanha e controlar todo o fluxo de trabalho de prospecção via API da Snov.io. 

• Prepare a configuração da conta
• Prepare a lista de prospects

Métodos da API de Campanhas

• Obter a configuração da conta
• Gerenciar contas de e-mail do remetente
• Criar e gerenciar campanhas
• Adicionar e atualizar conteúdo de e-mail
• Gerenciar destinatários

As APIs estão disponíveis em todos os planos do Sales Suite. 

O que você pode fazer com a API de Campanhas:

1) Executar campanhas automaticamente. Crie, edite e lance campanhas por meio de requisições de API.

2) Obter webhooks em tempo real. Acompanhe respostas, convites de conexão aceitos, respostas de InMail, respostas automáticas e outras ações dos prospects assim que elas acontecerem.

3) Sincronizar dados de atividade com suas ferramentas. Envie dados de atividade de campanhas e destinatários diretamente para seu CRM, painéis ou plataformas de análise.

Antes de começar a usar a API de Campanhas 

Prepare a configuração da conta 

• Conecte pelo menos uma conta de e-mail de remetente. Aqueça suas contas de remetente usando o Aquecimento de E-mail no aplicativo ou a API de Aquecimento de E-mail antes de lançar as campanhas. 
• Crie pelo menos um cronograma de envio em Cronogramas de campanha 
• Crie ou importe pelo menos uma lista de não-contato em Lista de não contatar, ou adicione-a por meio do método de API 
• Prepare a lista de prospects

• Crie uma nova lista de prospects
• Adicione prospects a uma lista

Métodos da API de Campanhas 

Aqui estão os métodos de API divididos por etapa do fluxo de trabalho: 

O fluxo de trabalho da API de Campanhas é melhor utilizado nesta ordem: prepare as contas de remetente e as listas de destinatários, crie uma campanha, adicione o conteúdo da sequência, lance a prospecção e, em seguida, monitore o desempenho por meio de webhooks e APIs de análise. 

Obtenha a configuração da conta 

Esses métodos ajudam a recuperar sua configuração de envio existente que já foi adicionada à sua conta. Você precisará dos IDs de cada uma das configurações abaixo ao usar o método de API para criar uma campanha. 

Obter suas contas de e-mail de remetente 

Obtenha o ID da conta de remetente e confirme os limites diários antes de atribuir a conta a uma campanha. 

Retorna todas as contas de e-mail conectadas com seus respectivos nomes de remetente, endereços de e-mail, limites diários e informações do provedor. 

Verificar o status SMTP/IMAP da conta de remetente 

Verifique se a conexão da conta está ativa e sem erros antes de usá-la em uma campanha. 

Entrada obrigatória: 

email — o endereço de e-mail da conta de remetente a ser verificada 

Obter suas listas de não-contato 

Recupere as listas de não-contato criadas em sua conta.

Obtenha o ID da lista de não-contato que você atribuirá a uma campanha para excluir automaticamente contatos específicos de receberem a sequência.

Obter seus cronogramas de campanha 

Obtenha o ID do cronograma que você usará para uma campanha. 

Retorna todos os cronogramas criados em sua conta, incluindo fuso horário, dias ativos e janelas de envio. 

Gerenciar contas de e-mail do remetente 

Esses métodos permitem conectar, configurar e aquecer contas de e-mail. 

Adicionar uma nova conta de e-mail 

Conecta uma conta de e-mail usando configurações de SMTP e IMAP, para que você possa atribuí-la como remetente em suas campanhas. 

Entrada obrigatória: 

As credenciais SMTP e as configurações de servidor da conta. 

sender_name, email_from, password, smtp.host, smtp.port, smtp.encryption

Entrada opcional 

• Configurações de IMAP: Rastrear respostas para e-mails enviados a partir desta conta de remetente 
• O intervalo entre os e-mails: Se não for especificado, a conta usará o intervalo padrão de 600 segundos entre os e-mails 
• Limite diário de envio: Se não for especificado, a conta usará o limite padrão do SMTP - 50 e-mails/dia 

Nota: O login do Gmail e as conexões OAuth da Microsoft só podem ser configurados no aplicativo, em Contas de E-mail (eles não estão disponíveis por meio deste método de API).

Atualizar uma conta de e-mail 

Atualiza as configurações de uma conta de remetente existente, como limites diários de envio ou nome de exibição, sem a necessidade de reconectá-la. Apenas os campos incluídos no corpo da requisição serão atualizados; todo o resto permanece como está. 

Entrada obrigatória: 

account_id — o ID da conta de remetente a ser atualizada 

Iniciar aquecimento 

Entrada obrigatória: 

sender_account_id — ID da conta de e-mail a ser aquecida

per_day — Meta diária de envio, o número de e-mails enviados diariamente no aquecimento. Para o aquecimento inicial, recomendamos definir este limite para 40 e-mails por dia. Dependendo do seu plano, este limite pode ser de até 1000 e-mails

strategy — Escolha a estratégia de aquecimento: progressiva para aumentar gradualmente o volume diário de envio para contas novas ou inativas (recomendado de 2 a 40 e-mails), ou constante para manter a reputação do remetente com um volume diário fixo

email_content — Você pode aquecer seu próprio modelo de e-mail para melhorar a entregabilidade dele ou usar conteúdo gerado por IA

Criar e gerenciar campanhas

Esses métodos permitem configurar campanhas com sua configuração completa: etapas da sequência (e-mail + LinkedIn), cronograma, rastreamento, contas de remetente, lista de destinatários e configurações de envio.

Criar uma nova campanha

Crie uma campanha e obtenha o ID da campanha que você usará em todas as chamadas de API subsequentes. 

Cria um novo rascunho de campanha com as configurações essenciais exigidas para o lançamento. 

Entrada obrigatória: 

Nome da campanha, cronograma de envio e pelo menos uma conta de remetente. 

name, schedule_id, sender_account_ids

Adicionar prospects duplicados não criará um destinatário duplicado na mesma campanha. Para evitar duplicatas em toda a sua conta, use o parâmetro sending_settings.skip_recipients no método Criar campanha.

Obter informações da campanha

Verifique as configurações atuais e o status de uma campanha antes de fazer atualizações ou lançá-la.

Recupera detalhes completos sobre uma campanha específica — status, contas de remetente, configurações de envio, destinatários e etapas da sequência. 

Entrada obrigatória:

campaign_id — ID da campanha na URL da requisição

Atualizar uma campanha

Atualize as configurações da campanha antes do lançamento ou enquanto a campanha estiver pausada. Apenas as configurações incluídas no corpo da requisição serão alteradas.

Entrada obrigatória:

campaign_id — ID da campanha na URL da requisição, além de quaisquer campos que você queira atualizar

Alterar status de campanhas 

Controle o ciclo de vida da campanha: inicie a prospecção, pause-a ou encerre a campanha quando terminar. Este método atualiza a campanha para um novo status: ativa, pausada, reiniciada, concluída ou arquivada.

Entrada obrigatória:

campaign_id — o ID da campanha na URL da requisição; action — o status de destino para o qual deseja alternar

Status aceitos: Iniciar, Pausar, Retomar, Concluir, Arquivar

Excluir campanha 

Remove permanentemente a campanha da sua conta. 

Entrada obrigatória: 

campaign_id — ID da campanha na URL da requisição

Apenas campanhas com o status Nova (rascunho), Completa ou Arquivada podem ser excluídas.

Adicionar e atualizar conteúdo de e-mail 

Esses métodos permitem gerenciar o conteúdo (linha de assunto e corpo) de cada etapa de e-mail em uma sequência de campanha.

Criar conteúdo da etapa de e-mail

Adicione a linha de assunto e o corpo do e-mail.

Adiciona um bloco de conteúdo à etapa de e-mail especificada na sequência. 

Entrada obrigatória: 

campaign_id, step_id —  ID da campanha e ID da etapa na URL

subject, body — a linha de assunto e o conteúdo do corpo do e-mail

Obter conteúdo da etapa de e-mail

Revise o conteúdo atual do e-mail antes de fazer atualizações. 

Retorna um bloco de conteúdo específico para uma etapa de e-mail. 

Entrada obrigatória: 

campaign_id, step_id, content_id — campaign ID, step ID, and content block ID in the URL

Atualizar conteúdo da etapa de e-mail 

Edita a linha de assunto ou o corpo de uma etapa de e-mail sem substituir todo o bloco de conteúdo

Entrada obrigatória:

campaign_id, step_id, content_id — ID da campanha, ID da etapa e ID do bloco de conteúdo na URL; além de quaisquer campos de conteúdo a serem atualizados 

Excluir conteúdo da etapa de e-mail

Remove um bloco de conteúdo de uma etapa de e-mail.

Entrada obrigatória:

campaign_id, step_id, content_id — ID da campanha, ID da etapa e ID do bloco de conteúdo na URL

Gerenciar destinatários

Esses métodos permitem controlar o status dos seus clientes potenciais (prospects) dentro de uma campanha.

Alterar o status de um destinatário

Interrompa ou ajuste manualmente o envio para um cliente potencial específico (ex.: se ele respondeu por um canal diferente ou precisa ser excluído no meio da sequência). Este método atualiza o status de um destinatário específico em uma campanha.

Entrada obrigatória:

campaign_id — o ID da campanha na URL; email, status — o e-mail do cliente potencial e o novo status a ser aplicado

Verificar status do destinatário

Verifique o status atual de envio de um destinatário antes de fazer alterações de status ou adicioná-lo a uma campanha. Basicamente, este método verifica se os endereços de e-mail especificados estão incluídos como destinatários em uma campanha específica.

Entrada obrigatória: 

campaign_id, recipient_id — o ID da campanha e o ID do destinatário na URL

Próximos passos na API

Estes guias cobrem as etapas restantes no fluxo de trabalho da campanha, ou seja, configurar notificações de eventos em tempo real e extrair dados de desempenho.

Configurar webhooks

Inscreva-se em eventos de campanha e receba notificações em tempo real na URL do seu endpoint. Para a lista completa de eventos suportados, métodos e detalhes de payload, consulte o guia de Webhooks.

Obter análises e relatórios de campanha

Recupere dados de engajamento para destinatários individuais e métricas agregadas de desempenho de campanha. Para a lista completa de métodos de relatório, parâmetros e exemplos de resposta, consulte o guia da API de análise de campanha.