Com a API da Papo (https://papo.global/) você automatiza a criação, o envio e a análise de campanhas de e‑mail marketing diretamente do seu sistema, sem acessar o painel manualmente. Os endpoints de Email Marketing permitem gerenciar campanhas, templates, audiências e métricas de desempenho por meio de chamadas REST, usando a mesma autenticação por chave secreta que o restante da API.
Resumo das operações via API
| Operação | O que você pode fazer programaticamente |
|---|---|
| Listar campanhas | Obter a relação de campanhas com métricas (enviados, aberturas, cliques) para alimentar dashboards ou relatórios. |
| Criar campanha como rascunho | Criar uma nova campanha de e‑mail no estado de rascunho, definindo audiência, template, remetente e agendamento. |
| Disparar campanha | Lançar (enviar) uma campanha que já está em rascunho ou pausada, iniciando os disparos reais. |
| Enviar e‑mail individual | Disparar um único e‑mail imediatamente, ideal para comunicações transacionais ou testes. |
| Listar templates | Recuperar os modelos de e‑mail salvos na conta para reutilização nas campanhas. |
| Listar audiências | Obter as listas de contatos (audiências) disponíveis, incluindo as dinâmicas, para segmentação automática. |
Todas as operações seguem o padrão REST, com respostas em JSON e autenticação via Authorization: Bearer <secret_key>. Como qualquer outro endpoint da Papo, você precisa de uma chave secreta (sk_live_…) gerada no painel em Developers.
Como funciona: automatizando o ciclo completo de uma campanha
1. Autentique‑se e explore os endpoints
Antes de qualquer chamada, obtenha sua chave secreta no painel da Papo (seção Developers). A base URL é a mesma da API geral, e todas as requisições devem incluir o header de autorização. Com a chave em mãos, você pode listar as audiências e templates existentes para planejar a campanha.
2. Crie uma campanha em modo rascunho
Use o endpoint de criação de campanha de e‑mail (modo rascunho) para montar o disparo sem enviá‑lo imediatamente. Na requisição, você informa:
- A credencial de envio (caixa de e‑mail configurada).
- O ID do template (ou o payload do conteúdo se criar inline).
- A audiência (ID da lista ou um array de contatos).
- Configurações opcionais como data/hora de agendamento e janelas de envio.
A resposta devolve o identificador único da campanha, permitindo que você a recupere posteriormente.
3. Dispare a campanha ou agende o envio
Com o ID da campanha em mãos, você pode dispará‑la (lançar) com outra chamada. Se preferir agendamento automático, basta incluir os campos de data e hora no momento da criação – a campanha ficará em rascunho programado e será enviada no momento definido.
4. Monitore o desempenho
Utilize o endpoint de listagem de campanhas para consultar as métricas a qualquer momento. Você receberá dados como total de enviados, taxa de abertura e número de cliques. Esses números podem ser puxados para dentro de dashboards no seu sistema (por exemplo, Google Data Studio, Power BI ou planilhas) usando chamadas periódicas ou webhooks.
Casos de uso típicos
- Nutrição de leads orientada por eventos: Um webhook do seu ERP informa que um lead atingiu determinada pontuação; seu sistema dispara automaticamente uma campanha de e‑mail via API, movendo o lead para a próxima etapa.
- Relatórios corporativos unificados: A sua ferramenta de BI consulta periodicamente as métricas de campanhas e as combina com dados de vendas, tudo de forma programada.
- Automações no n8n ou Zapier: Crie fluxos que, ao receber um novo contato no CRM, criam um rascunho de campanha de boas‑vindas e a disparam sem intervenção manual.
- Revenda white label: Integre a criação e o gerenciamento de campanhas no seu próprio portal de cliente, mantendo a identidade visual da sua marca enquanto usa a infraestrutura da Papo.
Para quem é essa solução
- Desenvolvedores e equipes de TI que desejam integrar o marketing de e‑mail a sistemas internos.
- Agências que precisam gerar campanhas em lote para dezenas de clientes sem acessar o painel de cada um.
- Revendedores white label que querem oferecer disparo de e‑mail como parte do seu portfólio, controlado via API.
- Empresas que utilizam automações no n8n, Zapier ou scripts customizados.
Perguntas frequentes
Preciso de uma chave de API diferente para usar os endpoints de Email Marketing?
Não. As mesmas chaves (pública e secreta) que você já utiliza para os demais recursos da Papo funcionam nos endpoints de e‑mail. A autenticação é a mesma, via header Authorization: Bearer.
Posso enviar um único e‑mail, como uma notificação transacional?
Sim. A API permite envios individuais e imediatos, sem a necessidade de criar uma campanha. Basta informar o destinatário, assunto, conteúdo e credencial de envio.
Como sei se a campanha foi realmente disparada?
Ao chamar o endpoint de lançamento, a API retorna o status da campanha. Depois, você pode consultar a listagem de campanhas para verificar se o status passou de "rascunho" para "enviando" ou "concluída" e obter as métricas de progresso.
Quais métricas a API retorna?
As respostas incluem ao menos o total de e‑mails enviados, aberturas e cliques. Os exatos campos disponíveis são documentados no endpoint de listagem, que pode ser explorado com ferramentas como Postman ou a própria interface de descoberta da API.
Posso criar templates de e‑mail pela API?
A funcionalidade atual de listagem de templates permite recuperar os modelos já existentes na conta. A criação de novos templates pode ser feita pelo painel; verifique a documentação atualizada para confirmar se a rota de criação está disponível via API.
É possível agendar uma campanha para uma data específica?
Sim. Ao criar o rascunho, você pode informar a data e hora desejadas. A campanha permanecerá nesse estado e será enviada automaticamente no momento programado, desde que não seja manualmente pausada.
Leia também
- Como usar a API da Papo para gerenciar Sequências de follow‑up
- Como usar a API da Papo para criar e atualizar contatos em massa
Centralize canais, automatize respostas com IA e gerencie campanhas de e‑mail — tudo em um só painel, sem custo inicial.