Enviar email transacional no Brevo, por uma API
Envia um email transacional aos endereços em to, na hora ou em scheduledAt, e retorna o messageId. Envie sender, subject e htmlContent ou textContent, ou um templateId, cujo sender e subject valem a menos que sejam enviados.
- Identificador
- brevo_send_transactional_email
A chamada
POST https://connect.reportei.com/api/tools/brevo_send_transactional_email/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"to": []
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| to | array | Sim | Recipients of the email. |
| sender | object | Não | Sender: email and name, or the id of a sender of the account. Required without templateId. |
| subject | string | Não | Subject of the email. Required without templateId. |
| htmlContent | string | Não | Body of the email as HTML. Required without templateId. |
| textContent | string | Não | Plain text body of the email. Ignored with templateId. |
| templateId | integer | Não | Id of a transactional template, shown next to its name in the templates list of Brevo. |
| params | object | Não | Values for the variables of the template, as key and value. |
| cc | array | Não | Recipients in copy. |
| bcc | array | Não | Recipients in blind copy. |
| replyTo | object | Não | Address that receives the replies. |
| tags | array | Não | Tags to categorize the email. |
| scheduledAt | string | Não | When to send, with the time zone. Scheduled emails may go out up to 5 minutes late. |
Conexões possíveis
O seu cliente conecta a conta do Brevo uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/brevo_send_transactional_email. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Brevo
- Listar contatosGETLista os contatos, do mais recente ao mais antigo por padrão, podendo filtrar por lista, data ou atributo. A resposta traz contacts e count; pagine com limit e offset.
- Obter contatoGETRetorna um contato com seus atributos, listas e as estatísticas de campanhas dos últimos 90 dias.
- Criar contatoPOSTCria um contato. Envie email, ou o atributo SMS, ou ext_id. Com updateEnabled true, um contato existente com o mesmo identificador é atualizado em vez de falhar.
- Atualizar contatoPUTAtualiza um contato. Só os campos enviados mudam: listIds inclui o contato em listas e unlinkListIds o remove de listas.
- Listar listas de contatosGETLista as listas de contatos com id, name, folderId e assinantes únicos. A resposta traz lists e count; pagine com limit e offset.
- Criar lista de contatosPOSTCria uma lista de contatos vazia em uma pasta e retorna o id dela.
- Listar campanhas de emailGETLista as campanhas de email, da mais recente à mais antiga por padrão. A resposta traz campaigns e count; pagine com limit e offset. As estatísticas só vêm quando statistics é enviado.
- Obter campanha de emailGETRetorna uma campanha de email com suas configurações, destinatários e estatísticas do relatório.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
