Skip to content

Enviando mensagens de e-mail usando a API REST

Use a API REST da Braze para enviar e-mails de transação a partir do seu backend em tempo real. Essa abordagem permite que você crie um serviço que envia e-mails de forma programática, enquanto rastreia a análise de dados de entrega junto com suas outras campanhas e canvas no dashboard da Braze.

Isso pode ser especialmente útil para envio de mensagens transacionais em que o conteúdo é definido nos seus sistemas de backend. Por exemplo, você pode notificar consumidores quando eles recebem uma mensagem de outro usuário, convidando-os a visitar seu site e verificar a caixa de entrada.

Com essa abordagem, você pode:

  • Disparar e-mails a partir do seu backend em tempo real.
  • Rastrear análise de dados junto com todas as suas campanhas e canvas gerenciados pelo marketing, incluindo aberturas, cliques e bounces.
  • Usar dados de interação com mensagens para disparar mensagens subsequentes, como redirecionamento de acompanhamento.
  • Estender o caso de uso com recursos adicionais da Braze, como postergação de mensagens e Testes A/B.
  • Opcionalmente, mudar para entrega disparada por API para definir seus modelos de e-mail no dashboard da Braze enquanto ainda dispara envios a partir do seu backend.

Para enviar um e-mail pela API REST, você precisa configurar uma campanha de API no dashboard da Braze e, em seguida, usar o endpoint /messages/send para enviar a mensagem.

Pré-requisitos

Para concluir este guia, você precisa de:

Etapa 1: Criar uma campanha de API

  1. No dashboard da Braze, acesse Envio de mensagens > Campanhas.
  2. Selecione Criar campanha e, em seguida, selecione Campanha de API.
  3. Insira um nome e uma descrição para sua campanha, como “Notificação de mensagem por e-mail”.
  4. Adicione tags relevantes para identificação e rastreamento.
  5. Selecione Adicionar canal de envio de mensagens e, em seguida, selecione E-mail.
  6. Anote o ID da campanha exibido na página da campanha. Você precisará desse valor ao construir sua solicitação de API. Opcionalmente, anote também o ID da variação de mensagem — inclua-o na sua solicitação se quiser atribuir estatísticas de envio a uma variação de mensagem específica.

Etapa 2: Enviar um e-mail usando a API

Construa uma solicitação POST para o endpoint /messages/send. Inclua o ID da campanha, o ID de usuário externo do destinatário e o conteúdo do e-mail na carga útil da solicitação.

Exemplo de solicitação

1
2
3

POST https://YOUR_REST_ENDPOINT/messages/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

Substitua YOUR_REST_ENDPOINT pela URL do endpoint REST do seu espaço de trabalho.

1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "external_user_ids": ["user123"],
  "messages": {
    "email": {
      "app_id": "YOUR_APP_ID",
      "message_variation_id": "YOUR_MESSAGE_VARIATION_ID",
      "subject": "You have a new message!",
      "from": "Notifications <[email protected]>",
      "body": "<html><body><h1>You have a new message!</h1><p>Hi {{${first_name}}},</p><p>You received a new message in your inbox. Click the link below to read it:</p><a href='https://yourwebsite.com/messages'>View message</a><p>Thank you for using our service!</p></body></html>"
    }
  }
}

Substitua os valores de espaço reservado pelos seus IDs reais. O campo from deve usar o formato "Nome de Exibição <[email protected]>". O campo body aceita HTML válido e suporta personalização com Liquid, para que você possa adaptar o conteúdo do e-mail para cada destinatário. Para a lista completa de parâmetros suportados pelo objeto de envio de mensagens de e-mail, consulte Objeto de e-mail.

Após construir a solicitação, envie a solicitação POST do seu serviço de backend para a API REST da Braze.

Etapa 3: Verificar sua integração

Após concluir a configuração, verifique sua integração:

  1. Envie uma solicitação de API conforme descrito na Etapa 2, usando seu próprio ID de usuário como destinatário.
  2. Confirme que o e-mail foi entregue na sua caixa de entrada.
  3. No dashboard da Braze, acesse a página de resultados da campanha e confirme que o envio foi registrado.
  4. Monitore os resultados de perto à medida que você escala sua campanha.

Considerações
Github   Editar esta página no GitHub
New Stuff!