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âmetroTipoObrigatórioDescrição
toarraySimRecipients of the email.
senderobjectNãoSender: email and name, or the id of a sender of the account. Required without templateId.
subjectstringNãoSubject of the email. Required without templateId.
htmlContentstringNãoBody of the email as HTML. Required without templateId.
textContentstringNãoPlain text body of the email. Ignored with templateId.
templateIdintegerNãoId of a transactional template, shown next to its name in the templates list of Brevo.
paramsobjectNãoValues for the variables of the template, as key and value.
ccarrayNãoRecipients in copy.
bccarrayNãoRecipients in blind copy.
replyToobjectNãoAddress that receives the replies.
tagsarrayNãoTags to categorize the email.
scheduledAtstringNãoWhen 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.

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.