Como incluir uma nova variável para envio de notificação?

Atualizado 4 months ago por Daniel Augusto

O Boleto Simples possui diversas variáveis para você deixar as suas notificações com informações sobre o seu cliente ou boleto, como o nome do cliente, data de vencimento do boleto, entre outros. 

Conheça mais sobre as variáveis que você pode incluir no seus e-mails de notificação: Como utilizar variáveis nos meus e-mails de notificação?

Porém, algumas informações não estão no cadastro do seu cliente ou no seu boleto, como, por exemplo, o nome do produto ou número do pedido. Nesses casos, você pode utilizar o campo meta, disponível para preenchimento através da API ou na importação de boletos via CSV.

O campo Meta é composto de uma variável e o dado dentro dela, que é o que será passado no e-mail para seus clientes e nesse artigo usaremos order_id e order_number como exemplos.

Preenchendo o campo Meta através da importação de boletos via CSV

Antes de importar o seu CSV no sistema do Boleto Simples, caso você queira inserir algum dado que não existe na planilha padrão, como, por exemplo, o número do pedido dos seus clientes, você pode adicionar essa informação na coluna meta. 

Para inserir essa informações, você deve seguir o seguinte padrão: "nome da variável": valor dela. No exemplo abaixo, estamos incluindo na linha 2 o order id 2321, já na linha 3 estamos inserindo duas informações o order id 2131 e o order number 100005. Inclua quantas informações desejar sempre seguindo o padrão do exemplo abaixo

Sabia mais sobre a Importação de Boletos via CSV lendo este artigo: Posso importar boletos através de uma planilha em Excel ou do Google Sheets?

Preenchendo o campo Meta pela API

Ao criar um boleto, você deve inserir as informações que deseja no campo meta, preenchido com um JSON, seguindo todas as regras sintáticas do mesmo.

Saiba mais sobre essa funcionalidade na documentação da nossa API, visto nas referências dos dados de boleto bancário.

Assim como na Importação via CSV, é possível colocar mais de uma variável no campo meta também pela API. Basta criar outra variável dentro do JSON.

Incluindo o campo meta nas suas notificações

Agora que você já incluiu os campos que deseja no nosso sistema, você pode colocar essas informações nas suas notificações enviadas aos seus clientes. Importando via CSV ou incluindo pela API, você deve inserir as informações da seguinte forma: {{ bank_billet.meta | json: "nome da variável" }}.

No exemplo a seguir, queremos incluir as variáveis order_id e order_number na nossa notificação.


Como você avalia esse artigo?