Configuração

Uma campanha de TagMail define a comunicação que será enviada aos usuários a partir de um gatilho de envio. Ela reúne as configurações gerais da campanha, como nome, remetente, período de ativação, prioridade e os steps de envio que compõem a sequência de e-mails.

Cada campanha deve estar associada a um gatilho e pode conter um ou mais steps.

Campos da Campanha

Campo	Tipo	Obrigatório	Valor padrão	Descrição
name	string	Sim	—	Nome da campanha.
campaignVariables	string	Não	—	Variáveis reutilizáveis da campanha, utilizadas no conteúdo dos e-mails.
senderEmail	string	Sim	—	Endereço de e-mail remetente da campanha.
senderName	string	Não	—	Nome do remetente exibido ao usuário.
priority	integer	Não	0	Prioridade da campanha.
active	boolean	Não	false	Indica se a campanha está ativa.
startDate	datetime	Não	—	Data de início da campanha.
endDate	datetime	Não	—	Data de término da campanha.
trigger	TriggerEnvio	Sim	—	Gatilho de envio associado à campanha.
steps	Step[]	Sim	—	Lista de steps de envio da campanha.

name

Tipo: string
Obrigatório: Sim

Nome identificador da campanha. Esse nome é utilizado para organização e gestão dentro da plataforma. Recomenda-se utilizar nomes claros, que facilitem a identificação do objetivo da campanha.

---

campaignVariables

Tipo: string
Obrigatório: Não

Conjunto de variáveis reutilizáveis da campanha. Esse campo permite definir valores que poderão ser usados nos steps de envio, evitando repetição de conteúdo.

É útil, por exemplo, para armazenar:

• Links de redes sociais;
• URLs institucionais;
• Links padrão de navegação;
• Informações fixas utilizadas em múltiplos e-mails da mesma campanha.

Exemplo de preenchimento:

{
    "{{FACEBOOK}}": "https://www.facebook.com/sua-pagina",
    "{{INSTAGRAM}}": "https://www.instagram.com/sua-conta",
    "{{YOUTUBE}}": "https://www.youtube.com/seu-canal"
}

O formato deve ser exatamente um JSON com chaves no padrão {{VARIAVEL}}.

---

senderEmail

Tipo: string
Obrigatório: Sim

Endereço de e-mail que será utilizado como remetente da campanha.

É esse endereço que o usuário verá como origem da mensagem, junto ou não ao nome do remetente.

danger

Esse e-mail deve estar corretamente habilitado para envio dentro da configuração do produto.

---

senderName

Tipo: string
Obrigatório: Não

Nome do remetente exibido ao usuário no e-mail.

Esse campo ajuda no reconhecimento da marca e torna a comunicação mais clara para o destinatário.

Exemplos:

• Minha Loja
• Equipe Minha Loja
• Atendimento Minha Marca

Quando não informado, o envio poderá utilizar apenas o endereço configurado em senderEmail.

---

priority

Tipo: integer
Obrigatório: Não
Valor padrão: 0

Descrição:
Define a prioridade da campanha.

Esse campo é utilizado para ordenação ou precedência entre campanhas, quando necessário.

Na maioria dos cenários, o valor padrão é suficiente.

Só deve ser ajustado quando houver uma estratégia específica de priorização entre campanhas que possam competir pelo mesmo contexto de envio.

Uma campanha com maior prioridade tem precedencia de envios para uma campanha de menor prioridade

---

active

Tipo: boolean
Obrigatório: Não
Valor padrão: false

Indica se a campanha está ativa e apta a ser executada.

Uma campanha inativa permanece cadastrada na plataforma, mas não será utilizada nos envios.

---

startDate

Tipo: datetime
Obrigatório: Não

Data e hora a partir da qual a campanha poderá ser executada.

Esse campo é útil para campanhas com início programado.

Se não informado, a campanha poderá ser executada assim que estiver ativa e com os demais requisitos atendidos.

---

endDate

Tipo: datetime
Obrigatório: Não

Data e hora limite para execução da campanha.

Após essa data, a campanha deixa de ser elegível para envio.

Esse campo é útil para:

• Campanhas temporárias;
• Ações promocionais com prazo definido;
• Campanhas sazonais.

---

trigger

Tipo: objeto
Obrigatório: Sim

Descrição:
Gatilho de envio associado à campanha.

É esse item que define quando a campanha poderá ser executada.

A campanha só será disparada quando as condições definidas no gatilho forem atendidas.

Exemplos de uso:

• Login
• Sign-up
• Abandono de carrinho
• Fim de jornada

Sem um gatilho de envio configurado, a campanha não pode funcionar.

---

Steps

Tipo: lista
Obrigatório: Sim

Lista de steps de envio da campanha. Cada step representa um e-mail da sequência e define:

• Assunto;
• Conteúdo;
• Momento de envio após o gatilho.

Uma campanha pode ter:

• Apenas 1 step;
• Ou vários steps, formando uma régua de comunicação ao longo do tempo.

Exemplo:

• Step 1 → envio após 30 minutos
• Step 2 → envio após 24 horas
• Step 3 → envio após 48 horas

Campos do Step

Os Steps definem os e-mails que compõem uma campanha de TagMail.

Cada step representa um envio da sequência e contém as informações necessárias para montar e agendar esse e-mail, como assunto, conteúdo e tempo de disparo.

Uma campanha pode ter um ou vários steps, dependendo da estratégia desejada.

Campo	Tipo	Obrigatório	Valor padrão	Descrição
name	string	Não	—	Nome identificador do step.
subject	string	Sim	—	Assunto do e-mail.
deliveryDelayMinutes	integer	Não	0	Tempo de espera, em minutos, antes do envio.
htmlBody	string	Sim	""	Conteúdo HTML do e-mail.

name

Tipo: string
Obrigatório: Não

Descrição:
Nome identificador do step de envio.

Esse campo é utilizado para facilitar a organização interna da campanha, especialmente quando ela possui mais de um step.

Exemplos:

• step_1_boas_vindas
• step_2_lembrete
• step_3_ultima_chance

subject

Tipo: string
Obrigatório: Sim

Descrição:
Assunto do e-mail que será exibido ao destinatário.

Esse campo é obrigatório e deve ser configurado com clareza, já que impacta diretamente a abertura da mensagem.

Exemplos:

• Seu carrinho continua disponível
• Bem-vindo à nossa loja
• Seu pedido foi confirmado

---

deliveryDelayMinutes

Tipo: integer
Obrigatório: Não
Valor padrão: 0

Descrição:
Define o tempo de espera, em minutos, entre o gatilho de envio da campanha e o envio deste step.

Exemplos:

• 0 → envio imediato
• 30 → envio após 30 minutos
• 1440 → envio após 24 horas

Esse campo permite construir réguas de comunicação com múltiplos envios ao longo do tempo.

---

htmlBody

Tipo: string
Obrigatório: Sim

Descrição:
Conteúdo HTML do e-mail.

Esse campo define a estrutura visual e o conteúdo do step.
Ele pode conter:

• Texto fixo;
• HTML de layout;
• Variáveis de campanha;
• Variáveis vindas de capturas;
• Estruturas dinâmicas, como listas de produtos.

O HTML deve ser compatível com renderização de e-mail. Ver exemplos. Ver boas práticas.

Observações Importantes

• Toda campanha deve estar associada a um gatilho de envio.
  Sem isso, a campanha não será executada.

• Toda campanha deve possuir ao menos um step de envio.
  Sem steps, não há e-mails para enviar.

• Para que a campanha funcione corretamente, é necessário:

  • Um remetente válido (senderEmail);
  • Capturas corretamente configuradas no gatilho.

• Caso queira utilizar um endereço de envio próprio da Etag, entre em contato com o suporte para configuração.