Bootstrap

Como criar campanha de E-mail via API

Pré-requisito:

  1. Criando uma Campanha de E-mail Marketing
  • Campo "name" - identificação da campanha;
  • Campo "sender" - remetente que será utilizado na mensagem, ele deve ser um e-mail autenticado e configurado;
  • Campo "reply_to" - e-mail, diferente do remetente, que receberá a resposta do contato;
  • Campo "email_template" - modelo de e-mail utilizado para envio da campanha;
  • Campo "lists" - listas utilizadas no envio das campanhas:
    • lista estática - /api/v1/contacts/list/id-da-lista-estatica
    • lista dinâmica - /api/v1/contacts/list/id-da-lista-dinamica
  • Campo "exclude_lists" - determina quais listas NÃO receberão a campanha;
  • Campo "open_lists" – adiciona o contato a uma ou mais listas, caso abra a campanha;
  • Campo "click_lists" - adiciona o contato a uma ou mais listas, caso clique na campanha;
  • Campo "date_scheduled" - utilizado para definir a programação da campanha, deverá ser no formado YYYY-MM-DD HH:MM;
  • Campo "exclude_hard_bounced" - exclui da lista os contatos classificados como Erros Permanentes;
  • Campo "subject" - identifica o assunto da campanha (esta informação aparecerá para o contato). Por padrão ele é definido como "null", e utiliza a mesma nomenclatura do Modelo de E-Mail.

    POST: /api/v1/campaigns/email_campaign/
    Texto O conteúdo gerado por IA pode estar incorreto.
    Resultado esperado:
    Texto O conteúdo gerado por IA pode estar incorreto.
    Obs.: A ID da Campanha de E-mail está nos atributos “ID” e “resource_url” (que poderá acessar os detalhes da lista a partir do endpoint) e será utilizada para relacionar as campanhas, quando forem criadas.
  1. Listando as Campanhas de E-mail

GET: /api/v1/campaigns/email_campaign/
Texto O conteúdo gerado por IA pode estar incorreto.
Resultado esperado:
Texto O conteúdo gerado por IA pode estar incorreto.
Será exibido um objeto no formato JSON, e terão 2 (dois) dicionários:

  • Meta - visão geral de quantos objetos você possui e o link da próxima página do objeto (atributo "next" do dicionário).
  • Objects - detalhe completo do objeto carregado no campo “resource_url”.

 

  • Listando as Campanhas por ID:

GET: /api/v1/campaigns/email_campaign/?id=xxx
Texto O conteúdo gerado por IA pode estar incorreto.

  • Listando as Campanhas por nome:

GET: /api/v1/campaigns/email_campaign/?name=teste

  • Listando as Campanhas por status:

GET: /api/v1/campaigns/email_campaign/?status=progress

Status disponíveis para consulta:
Linha do tempo O conteúdo gerado por IA pode estar incorreto.

 

  1. Atualizando uma Campanha de E-mail

PATCH: /api/v1/campaigns/email_campaign/XXX58/
Texto O conteúdo gerado por IA pode estar incorreto.

 

IMPORTANTE!

  • Somente campanhas com o status “Programada” poderão ser atualizadas;
  • Ao criar o remetente, o sistema enviará uma mensagem solicitando a confirmação por meio de um link.
  • Caso o domínio de envio já esteja configurado - através de autenticação por chave: DKIM, SPF e DMARC - a autenticação será realizada automaticamente.
  • Por padrão, o campo "exclude_hard_bounced" tem o valor "true". Caso seja alterado para "false", existe o risco da campanha ser cancelada por excesso de erros.

 

Pesquisar
Categorias
Artigos Populares