E-mail transacional

Se tiver o complemento de e-mail transacional, você pode enviar e-mails por um endereço IP dedicado para recibos de comércio eletrônico, atualizações de conta, alterações de termos de serviço e outras transações de negócios essenciais.

E-mails transacionais são para interações baseadas em relacionamento, ao contrário de e-mail de marketing, que normalmente é usado para promover conteúdo.

Métodos para envio de e-mail transacional 

três maneiras de implementar o e-mail transacional:

Método Visão geral Exemplo de caso de uso
E-mail transacional no aplicativo Crie e-mails transacionais com o editor de e-mail do HubSpot.

Isso fornece os mesmos benefícios de e-mails padrão do HubSpot, como conteúdo inteligente, personalização e modelos.

Saiba mais sobre como configurar e-mails transacionais no aplicativo.
Envie um e-mail de atualização de política aos seus clientes com um link para uma nova página de política. Essa é uma atualização de serviço, não um e-mail de marketing, portanto você não precisa incluir links de assinatura (por exemplo, links de CAN-SPAM). Você não precisa usar propriedades ou informações personalizadas de sistemas externos.
API SMTP
Envie e-mail transacional por meio do seu próprio site ou aplicativo enquanto controla o desempenho de e-mail e crie informações de contato no HubSpot. A capacidade opcional de criar informações de contato é baseada na criação de token de smtp.

Saiba mais na seção API SMTP abaixo 

Envie um e-mail de confirmação de assinatura de conta de um sistema de e-mail transacional separado, enquanto controla o desempenho de e-mail e criando contatos no HubSpot.
API de envio único Uma combinação de e-mail transacional no aplicativo e API SMTP.

Crie e-mails transacionais usando o editor de e-mail do HubSpot e adicione tokens externos personalizados ao seu e-mail que você pode enviar à HubSpot por meio da API.

Saiba mais em API de envio único abaixo 
Envie um e-mail de recibo de compra ao seu cliente usando o HubSpot. O e-mail é disparado quando a compra é feita e passa valores personalizados de outro sistema (por exemplo, um item comprado e total de compra). Além disso, acompanhe o desempenho desse e-mail no HubSpot.

Please note: any contacts who are CC'd on a transactional email will not be tracked and the email will not appear on the record timeline of the CC'd contact.

API SMTP

O e-mail transacional enviado com a API SMTP é acionado automaticamente por critérios específicos, como fazer uma compra em um site de comércio eletrônico. Esta API integra-se com sistemas internos ou de terceiros para disparar o email e incorporar dados armazenados fora do HubSpot (por exemplo, informações de envio ou preço de compra). O e-mail é enviado do seu sistema, mas está conectado a códigos de rastreamento do HubSpot que permitem rastreamento de engajamento e medições completos.

Para enviar um e-mail usando a API SMTP, você precisa usar um token de API SMTP para obter credenciais de login para o servidor SMTP da HubSpot. Depois de fazer login no servidor, você pode enviar o e-mail pelo SMTP. Se você não criou tokens de API SMTP, precisará gerar um novo token antes. Se já tiver criado tokens de API SMTP, veja os diferentes métodos para obter seus tokens pela API. Depois de obter o token, saiba sobre como fazer login no servidor SMTP da HubSpot.

Todos os domínios que você usa como o Endereço de remetente dos seus e-mails precisam estar conectados como domínio de envio de e-mail no HubSpot. Você encontrará um erro se enviar e-mails transacionais pela API SMTP usando um domínio não autorizado a enviar em nome da sua conta da HubSpot.

Please note: all methods in the SMTP API require an OAuth token for authentication.

If you prefer, all of the methods below for creating, retrieving, deleting, and resetting passwords for SMTP API tokens can be done within your HubSpot account, rather than the API.

Criar um novo token de API SMTP

Para criar um novo token de API SMTP, faça uma solicitação POST para /marketing/v3/transactional/smtp-tokens/.

O corpo da solicitação precisa ser um objeto formatado em JSON com as seguintes propriedades:

  • createContact: indica se um contato deve ser criado para destinatários de e-mail.
  • campaignName: um nome para a campanha associada ao token de API SMTP.

A resposta inclui SmtpApiTokenView, que contém:

  • id: nome de usuário para fazer login no servidor SMTP da HubSpot.
  • createdBy: endereço de e-mail do usuário que enviou a solicitação de criação do token.
  • password: a senha para fazer login no servidor SMTP da HubSpot.
  • emailCampaignId: identificador atribuído à campanha fornecida na solicitação de criação de token.
  • createdAt: data/hora gerada quando um token é criado.
  • createContact: indica se um contato deve ser criado para destinatários de e-mail.
  • campaignName: o nome da campanha associado ao token.

Com o token criado, você pode fazer login no servidor SMTP da HubSpot usando os valores de id e senha.

A senha de um token só pode ser recuperada no momento da criação. Se você perder a senha ou quiser definir uma nova, será necessário redefinir a senha do token

SMTP API tokens generated through the public API expire after 12 months. Once expired, they're automatically deleted.

Obter tokens de API SMTP existentes

Veja abaixo os métodos disponíveis de obter esses tokens usando a API.

Listar tokens de API SMTP por campanha

Para obter uma lista de tokens por nome de campanha, ou um token único por ID da campanha, faça uma solicitação GET para /marketing/v3/transactional/smtp-tokens.

Você também precisará incluir um parâmetro campaignName ou emailCampaignId com a solicitação. Você pode encontrar todos os detalhes da solicitação na guia Endpoints no canto superior deste artigo.

Detalhes da resposta

A resposta contém results e paging como campos de nível superior:

  • results: uma coleção de SmtpApiTokenView contendo:
    • id: nome de usuário para fazer login no servidor SMTP da HubSpot.
    • createdBy: endereço de e-mail do usuário que enviou a solicitação de criação do token.
    • emailCampaignId: identificador atribuído à campanha fornecida na solicitação de criação de token.
    • createdAt: data/hora gerada quando um token é criado.
    • createContact: indica se um contato deve ser criado para destinatários de e-mail.
    • campaignName: o nome da campanha associado ao token.
  • paging: contém um campo next.after que pode ser usado para solicitar mais resultados.

Consultar um token API SMTP único

Para consultar um token API SMTP único por ID, faça uma solicitação GET para /marketing/v3/transactional/smtp-tokens/{tokenId}.

Detalhes da resposta

A resposta inclui SmtpApiTokenView, que contém:

  • id: nome de usuário para fazer login no servidor SMTP da HubSpot.
  • createdBy: endereço de e-mail do usuário que enviou a solicitação de criação do token.
  • emailCampaignId: identificador atribuído à campanha fornecida na solicitação de criação de token.
  • createdAt: data/hora gerada quando um token é criado.
  • createContact: indica se um contato deve ser criado para destinatários de e-mail.
  • campaignName: o nome da campanha associado ao token.

Gerenciar tokens existentes

Depois de criar tokens, você pode redefinir uma senha ou excluir o token usando a API.

Redefinir senha

Para solicitar uma senha de token, faça uma solicitação POST para /marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset.

A resposta inclui SmtpApiTokenView, que contém:

  • id: nome de usuário para fazer login no servidor SMTP da HubSpot.
  • createdBy: endereço de e-mail do usuário que enviou a solicitação de criação do token.
  • emailCampaignId: identificador atribuído à campanha fornecida na solicitação de criação de token.
  • createdAt: data/hora gerada quando um token é criado.
  • createContact: indica se um contato deve ser criado para destinatários de e-mail.
  • campaignName: o nome da campanha associado ao token.

Excluir um token

Para excluir um token API SMTP único, faça uma solicitação DELETE para  /marketing/v3/transactional/smtp-tokens/{tokenId}. 

A resposta não inclui nenhum conteúdo.

Faça login no servidor SMTP da HubSpot

Veja abaixo os detalhes para fazer login no servidor SMTP da HubSpot, usando o nome de usuário (id) e a senha fornecida pelo seu token.

  • Hostname SMTP:
    • Se você não estiver com base na UE, use smtp.hubapi.com como nome do host.
    • Se você estiver na UE, use smtp-eu1.hubapi.com como nome do host.
  • Porta SMTP:
    • Se você não estiver na UE, use as portas 587 (para STARTTLS) ou 465 (para TLS).
    • Se estiver na UE, use as portas 587 ou 25 (para STARTTLS).
  • Nome do usuário SMTP: fornecido no campo ID
  • Senha SMTP: fornecida no campo de senha

API de envio único

A API de envio único envia e-mails de modelo criados na ferramenta de e-mail do HubSpot usando uma solicitação POST formatada em JSON. Todos os e-mails enviados por essa API serão associados automaticamente aos registros de contatos com base no endereço de e-mail. Se não houver contato com um endereço de e-mail correspondente, um novo contato com esse e-mail será criado. Se quiser enviar e-mails sem criar contatos, use a API SMTP.

Primeiro, configure seu e-mail no HubSpot. Depois que o e-mail for publicado, você pode definir os detalhes do destinatário, incluindo qualquer contato ou propriedades personalizadas configuradas no modelo de e-mail, no corpo da solicitação de API. Nesse momento, também é possível copiar o ID do e-mail na página de detalhes do e-mail, que você precisará para sua solicitação.

Captura de tela 15-04-2020 às 1.00.37 PM

HubSpot does not save the HTML/JSON sent through this API. You can review the email template from the recipient contact's timeline, but if you want to keep a record of the email's contents, it's recommended to add a BCC to the email.

Para enviar um email com a API de envio único, faça uma solicitação POST para /marketing/v3/transactional/single-email/send.

A resposta contém os seguintes campo:

    • requestedAt: a data/hora da solicitação de envio.
  • status: o status da solicitação de envio. Inclui PENDENTE, PROCESSANDO, CANCELADO e CONCLUÍDO.

Solicitar propriedades

O corpo da solicitação precisa ser um objeto formatado em JSON com as seguintes propriedades:

  • emailId
  • message
  • contactProperties
  • customProperties

emailId

O campo emailId contém o ID de conteúdo do e-mail transacional, que pode ser encontrado na ferramenta de e-mail do HubSpot.

message

O campo de mensagem é um objeto JSON contendo tudo que você deseja substituir. No mínimo, você deve incluir o campo to.

Campos de objeto de mensagem:

  • to: o destinatário do email
  • from: do cabeçalho "De" do email. Você pode definir um nome com o seguinte formato: "from":"Sender Name <sender@hubspot.com>"
  • sendId: o ID de um envio específico. Apenas um e-mail com um determinado sendId será enviado por conta, então você pode incluir esse campo para evitar envios de e-mail duplicados.
  • replyTo: uma lista JSON de valores de cabeçalho "Responder para" para o email.
  • cc: uma lista JSON de endereços de email a enviar como Cc.
  • bcc: uma lista JSON de endereços de e-mail para enviar como Cco.

contactProperties

O campo contactProperties é um mapa JSON dos valores de propriedade de contato. Cada valor de propriedade de contato contém um nome e valor. Cada propriedade será definida no registro do contato e será visível no modelo em {{ contact.Name }}. Use essas propriedades quando quiser definir uma propriedade de contato enquanto estiver enviando o e-mail. Por exemplo, ao enviar um recibo que você pode definir um last_paid_date property, pois o envio do recibo terá informações sobre o último pagamento.

As propriedades do contato podem ser formatadas da seguinte maneira:

{

  “property_name_1”: “property_value_1”,

  “property_name_2”: “property_value_2”

}

customProperties

O campo customProperties é um mapa JSON dos valores de propriedade. Essas propriedades são geralmente relacionadas ao próprio e-mail, não ao contato que recebe o e-mail. Elas não aparecerão na versão da página web do e-mail ou na exibição do tempo da linha do tempo do contato. Essas propriedades também não são armazenadas no HubSpot e serão incluídas apenas no e-mail enviado.

Cada valor de propriedade contém uma propriedade nome e valor e será visível no modelo abaixo de {{custom.NAME}}.

Por exemplo:

{

  “property_name_1”: “property_value_1”,

  “property_name_2”: “property_value_2”

}

Propriedades personalizadas permitem matrizes apenas quando usadas com conteúdo de e-mail programável. Você também pode criar uma lista HTML, com tabelas ou <ul> e especificá-la como uma propriedade personalizada.

Consultar o status de um envio de e-mail

Para obter o status do envio de e-mail, faça uma solicitação GET para https://api.hubapi.com/marketing/v3/email/send-statuses/{statusId}

A resposta contém os seguintes campo:

    • sendResult: um valor SendResult. Continue lendo para ver todos os valores disponíveis.
    • requestedAt: a data/hora da solicitação do envio.
  • startedAt: a data/hora de início do processamento do envio.
  • completedAt: a data/hora de conclusão do envio.
  • statusId: um identificador que pode ser usado para consulta o status do envio.
  • status: o status da solicitação de envio. Inclui PENDENTE, PROCESSANDO, CANCELADO e CONCLUÍDO.
  • eventId: se enviado, o ID e data/hora de criação do evento de envio.

SendResult

SendResult é uma enumeração de possíveis resultados ao tentar enviar o e-mail.

  • SENT: o e-mail foi enviado com sucesso.
  • QUEUED: o e-mail foi colocado na fila e será enviado à medida que a fila é processada.
  • PORTAL_SUSPENDED: devido a violações da Política de Utilização Responsável, o email do cliente do HubSpot foi suspenso.
  • INVALID_TO_ADDRESS: o endereço do destinatário é inválido.
  • BLOCKED_DOMAIN: o domínio não pode receber e-mails do HubSpot neste momento.
  • PREVIOUSLY_BOUNCED: o destinatário foi rejeitado anteriormente e a lógica de envio resultou em nenhum envio.
  • PREVIOUS_SPAM: o destinatário marcou um email semelhante como spam.
  • INVALID_FROM_ADDRESS: o endereço de remetente é inválido.
  • MISSING_CONTENT: o emailId é inválido, ou emailId corresponde a um email que não foi configurado para envio único.
  • MISSING_TEMPLATE_PROPERTIES: há propriedades personalizadas configuradas no modelo que não foram incluídas no customProperties enviado na solicitação.

Was this article helpful? *
This form is used for documentation feedback only. Learn how to get help with HubSpot...