Envoyer un email transactionnel avec l'API Brevo
Envoie un email transactionnel aux adresses de to, immédiatement ou à scheduledAt, et renvoie son messageId. Envoyez sender, subject et htmlContent ou textContent, ou un templateId, dont le sender et le subject s'appliquent sauf s'ils sont envoyés.
- Identifiant
- brevo_send_transactional_email
L'appel
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": []
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| to | array | Oui | Recipients of the email. |
| sender | object | Non | Sender: email and name, or the id of a sender of the account. Required without templateId. |
| subject | string | Non | Subject of the email. Required without templateId. |
| htmlContent | string | Non | Body of the email as HTML. Required without templateId. |
| textContent | string | Non | Plain text body of the email. Ignored with templateId. |
| templateId | integer | Non | Id of a transactional template, shown next to its name in the templates list of Brevo. |
| params | object | Non | Values for the variables of the template, as key and value. |
| cc | array | Non | Recipients in copy. |
| bcc | array | Non | Recipients in blind copy. |
| replyTo | object | Non | Address that receives the replies. |
| tags | array | Non | Tags to categorize the email. |
| scheduledAt | string | Non | When to send, with the time zone. Scheduled emails may go out up to 5 minutes late. |
Connexions possibles
Votre client connecte son compte Brevo une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/brevo_send_transactional_email. Il devient la définition de tool de votre agent sans conversion.
Autres tools Brevo
- Lister les contactsGETListe les contacts, du plus récent au plus ancien par défaut, avec filtre optionnel par liste, date ou attribut. La réponse contient contacts et count ; paginez avec limit et offset.
- Obtenir un contactGETRenvoie un contact avec ses attributs, ses listes et les statistiques de campagnes des 90 derniers jours.
- Créer un contactPOSTCrée un contact. Envoyez email, ou l'attribut SMS, ou ext_id. Avec updateEnabled à true, un contact existant ayant le même identifiant est mis à jour au lieu d'échouer.
- Mettre à jour un contactPUTMet à jour un contact. Seuls les champs envoyés changent : listIds ajoute le contact à des listes et unlinkListIds l'en retire.
- Lister les listes de contactsGETListe les listes de contacts avec id, name, folderId et abonnés uniques. La réponse contient lists et count ; paginez avec limit et offset.
- Créer une liste de contactsPOSTCrée une liste de contacts vide dans un dossier et renvoie son id.
- Lister les campagnes emailGETListe les campagnes email, de la plus récente à la plus ancienne par défaut. La réponse contient campaigns et count ; paginez avec limit et offset. Les statistiques ne reviennent que si statistics est envoyé.
- Obtenir une campagne emailGETRenvoie une campagne email avec ses réglages, ses destinataires et les statistiques de son rapport.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
