Guias
Etiqueta Branca Cada Email: Como funcionam os Modelos de Email Personalizados da Firma.dev
Quando integra as assinaturas eletrónicas no seu produto, os seus clientes não devem saber qual a plataforma que o está a motorizar. A experiência de assinatura deve parecer sua, incluindo todos os e-mails automatizados enviados durante o processo. O Firma.dev agora permite que personalize cada e-mail de notificação que a plataforma envia em seu nome, com controlo total sobre as linhas de assunto, os corpos em HTML, e sobreposições por espaço de trabalho.
Os Seus Clientes Veem a Sua Marca, Não a Nossa
Cada fluxo de trabalho de assinatura ativa uma série de e-mails automatizados: o convite inicial, a notificação do próximo signatário num fluxo sequencial, avisos de expiração, mensagens de cancelamento, e notificações de recusa. Antes dos modelos de e-mail personalizados, tudo isso era enviado com o texto e a formatação predefinidos do Firma.dev.
Agora é você quem controla os cinco:
Tipo de E-mail | Quando Envia |
|---|---|
| Quando um pedido de assinatura é enviado pela primeira vez a um destinatário |
| Quando é a vez do próximo signatário numa ordem de assinatura |
| Quando um pedido de assinatura expira |
| Quando um remetente cancela um pedido de assinatura |
| Quando um signatário se recusa a assinar |
Tanto a linha de assunto (texto simples, máx. 500 caracteres) como o corpo (HTML, máx. 50 000 caracteres) são totalmente personalizáveis para cada tipo. Pode fazer coincidir exatamente o tom de voz, o esquema, as cores e o texto da sua marca.
Marcadores de Posição Dinâmicos
Os modelos suportam uma sintaxe {{placeholder}} para injetar valores em tempo real no momento do envio. A lista completa de marcadores de posição disponíveis pode ser consultada através de GET /email-templates/placeholders, e inclui os que usará mais frequentemente:
{{signing_link}}— a ligação exclusiva do signatário para aceder ao documento{{signer_name}}— o nome do destinatário{{document_name}}— o nome do pedido de assinatura
Um exemplo prático do corpo de um signing_invite:
Uma nota para os programadores: se o corpo do seu modelo não contiver {{signing_link}}, a API devolve um aviso ao guardar. A gravação continua a ter sucesso, mas o aviso existe para detetar o erro antes que um signatário receba um e-mail sem forma de aceder ao documento.
Modelos ao Nível de Empresa e ao Nível de Espaço de Trabalho
O sistema de modelos utiliza uma hierarquia de três níveis: o modelo do espaço de trabalho tem precedência, seguido pelo modelo da empresa e, por fim, a predefinição integrada do Firma.dev. Isto dá-lhe dois padrões de integração naturais.
Definir uma Predefinição para Toda a Empresa
Configure o seu modelo personalizado uma vez ao nível da empresa e este aplicar-se-á a todos os espaços de trabalho que não tenham a sua própria sobreposição. O padrão do endpoint a partir do registo de alterações da API:
Sobrepor por Espaço de Trabalho
Para parceiros que utilizam o modelo de espaço de trabalho de cliente do Firma.dev, cada espaço de trabalho pode ter os seus próprios modelos de e-mail. Este exemplo de curl é do guia de marca branca:
Um espaço de trabalho que atenda clientes na Alemanha pode utilizar modelos no idioma alemão com a identidade de marca específica desse cliente, enquanto outro espaço de trabalho utiliza as predefinições de toda a sua empresa.
Ao eliminar o modelo de um espaço de trabalho, esse espaço de trabalho reverte para a predefinição ao nível de empresa. Ao eliminar o modelo de empresa, reverte para a predefinição integrada do Firma.dev. A cadeia de recurso tem sempre uma base segura.
Referência Completa da API
Endpoint | Descrição |
|---|---|
| Listar todos os modelos ao nível de empresa |
| Criar ou atualizar um modelo de empresa |
| Eliminar um modelo de empresa |
| Listar todos os modelos de espaço de trabalho |
| Obter um modelo de espaço de trabalho específico |
| Criar ou atualizar um modelo de espaço de trabalho |
| Eliminar um modelo de espaço de trabalho |
| Obter predefinições integradas para um idioma |
| Obter todos os marcadores de posição disponíveis |
O endpoint GET /email-templates/defaults/{language} é particularmente útil como ponto de partida: obtenha o modelo integrado para o seu idioma de destino, personalize-o e guarde-o novamente. Não é necessário escrever textos de e-mail a partir do zero.
Introdução
Os modelos de e-mail personalizados estão disponíveis a partir da versão v1.8.0 da API, sem alterações que causem incompatibilidades. Se já tiver feito a integração, pode começar a personalizar e-mails hoje mesmo sem alterar qualquer lógica existente de pedidos de assinatura.
Comece a utilizar o Firma.dev gratuitamente, sem necessidade de cartão de crédito. Todos os pedidos de assinatura têm o custo de 0,049 por envelope, sem mínimos mensais.
Artigos relacionados
A nossa plataforma foi projetada para capacitar empresas de todos os tamanhos a trabalhar de forma mais inteligente e alcançar seus objetivos com confiança.
