Envoyer un e-mail transactionnel

Envoie à partir d’un modèle transactionnel (template) ou d’un HTML fourni (html). L’e-mail est journalisé, suivi (ouvertures, clics si le modèle le demande) et compté dans le quota : chaque destinataire compte, copies comprises. Sans to, les destinataires par défaut du modèle sont utilisés ; les adresses de la liste de suppression sont retirées.

50 destinataires au plus par e-mail, to, cc et bcc ensemble (too_many_recipients). mailer nomme un fournisseur de l’équipe ou un fournisseur offert par la plateforme, jamais celui d’une autre équipe.

L’appel reçoit sa réponse dès que l’e-mail est journalisé, et l’e-mail part d’une file d’attente : la réponse est le plus souvent 202 avec status: pending. Suivez-le avec les webhooks transactional.*, ou relisez-le avec GET /v1/transactional-mails/{mail} jusqu’à ce que status vaille sent ou failed. Quand le fournisseur échoue, Lekalao réessaie après 5 s, 30 s, 2 min, 10 min et 30 min, et abandonne après le sixième échec ou six heures après l’appel (provider_error). Un e-mail encore pending après 7 heures passe failed avec failure_code: lost.

Un refus est une erreur avec l’e-mail journalisé sous data : 422 recipients_suppressed (toutes les adresses sont supprimées), 429 monthly_quota_exceeded (le quota est épuisé), 502 seulement quand le fournisseur ou la file d’attente a échoué.

Avec une clé de test, rien ne part : voir Clés de test.

POST

transactional-mails

send

Envoyer un e-mail transactionnel

curl --request POST \
  --url https://api.lekalao.com/v1/transactional-mails/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": "confirmation-commande",
  "to": [
    "ada@example.com"
  ],
  "locale": "fr",
  "variables": {
    "customer": {
      "name": "Ada"
    },
    "order": {
      "number": "2026-00481",
      "total": "12 500 FCFA",
      "items": [
        "Pain complet",
        "Croissant x4"
      ]
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    template: 'confirmation-commande',
    to: ['ada@example.com'],
    locale: 'fr',
    variables: {
      customer: {name: 'Ada'},
      order: {
        number: '2026-00481',
        total: '12 500 FCFA',
        items: ['Pain complet', 'Croissant x4']
      }
    }
  })
};

fetch('https://api.lekalao.com/v1/transactional-mails/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lekalao.com/v1/transactional-mails/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'template' => 'confirmation-commande',
    'to' => [
        'ada@example.com'
    ],
    'locale' => 'fr',
    'variables' => [
        'customer' => [
                'name' => 'Ada'
        ],
        'order' => [
                'number' => '2026-00481',
                'total' => '12 500 FCFA',
                'items' => [
                                'Pain complet',
                                'Croissant x4'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://api.lekalao.com/v1/transactional-mails/send"

payload = {
    "template": "confirmation-commande",
    "to": ["ada@example.com"],
    "locale": "fr",
    "variables": {
        "customer": { "name": "Ada" },
        "order": {
            "number": "2026-00481",
            "total": "12 500 FCFA",
            "items": ["Pain complet", "Croissant x4"]
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "sandbox": true,
    "failure_reason": "<string>",
    "failure_code": "recipients_suppressed",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z",
    "bounced_at": "2023-11-07T05:31:56Z",
    "complained_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "e3b0c442-98fc-4c14-9a1e-2f6b7d8a9c10",
    "template": "confirmation-commande",
    "subject": "Commande 2026-00481 confirmée",
    "from": "bonjour@maboulangerie.example",
    "to": [
      "ada@example.com"
    ],
    "cc": [],
    "bcc": [],
    "status": "pending",
    "failure_reason": null,
    "opens": 0,
    "clicks": 0,
    "sent_at": null,
    "created_at": "2026-09-17T10:14:02+00:00"
  }
}

{
  "message": "La clé d’idempotence est trop longue.",
  "code": "idempotency_key_too_long",
  "doc_url": "https://docs.lekalao.com/fr/errors#idempotency_key_too_long"
}

{
  "message": "Non authentifié.",
  "code": "unauthenticated",
  "doc_url": "https://docs.lekalao.com/fr/errors#unauthenticated"
}

{
  "message": "Cette équipe est suspendue. Contactez le support.",
  "code": "team_suspended",
  "doc_url": "https://docs.lekalao.com/fr/errors#team_suspended"
}

{
  "message": "Une requête portant cette clé d’idempotence est déjà en cours.",
  "code": "idempotency_key_in_use",
  "doc_url": "https://docs.lekalao.com/fr/errors#idempotency_key_in_use"
}

{
  "message": "Non envoyé : ada@example.com figure sur la liste de suppression.",
  "code": "recipients_suppressed",
  "doc_url": "https://docs.lekalao.com/fr/errors#recipients_suppressed"
}

{
  "message": "<string>",
  "code": "recipients_suppressed",
  "doc_url": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "sandbox": true,
    "failure_reason": "<string>",
    "failure_code": "recipients_suppressed",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z",
    "bounced_at": "2023-11-07T05:31:56Z",
    "complained_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "code": "recipients_suppressed",
  "doc_url": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "sandbox": true,
    "failure_reason": "<string>",
    "failure_code": "recipients_suppressed",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z",
    "bounced_at": "2023-11-07T05:31:56Z",
    "complained_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Autorisations

Authorization

string

header

requis

Jeton d'API. Aptitude « read » : routes GET seulement. « read + write » : toutes les routes.

En-têtes

Idempotency-Key

string

Rejouez une écriture sans risque : la même clé rend la première réponse pendant 24 heures (en-tête Idempotent-Replay: true). Lue sur POST, PUT et PATCH ; DELETE l'ignore. 255 caractères au plus.

Maximum string length: 255

Corps

application/json

template

string | null

Nom d'un modèle transactionnel de l'équipe.

html

string | null

Corps HTML, si aucun modèle n'est donné.

subject

string | null

Remplace l'objet du modèle.

string<email>[]

50 adresses au plus, cc et bcc compris.

Maximum array length: 50

string<email>[]

Maximum array length: 50

bcc

string<email>[]

Maximum array length: 50

variables

object

Remplissent le modèle : {{ order.number }}, boucles {% for %}…

locale

string | null

Version linguistique du modèle à envoyer (fr, pt-BR…). Sans valeur, la version de base.

from_email

string<email> | null

from_name

string | null

reply_to

string<email> | null

mailer

string | null

Le nom d'un fournisseur de l'équipe, ou d'un fournisseur offert par la plateforme, pour forcer celui-là. Tout autre nom est refusé.

attachments

object[]

Maximum array length: 10

Show child attributes

Réponse

L'e-mail était déjà remis au fournisseur quand la réponse est partie (status: sent).

data

object

Show child attributes

Envoyer un e-mail transactionnel

curl --request POST \
  --url https://api.lekalao.com/v1/transactional-mails/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": "confirmation-commande",
  "to": [
    "ada@example.com"
  ],
  "locale": "fr",
  "variables": {
    "customer": {
      "name": "Ada"
    },
    "order": {
      "number": "2026-00481",
      "total": "12 500 FCFA",
      "items": [
        "Pain complet",
        "Croissant x4"
      ]
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    template: 'confirmation-commande',
    to: ['ada@example.com'],
    locale: 'fr',
    variables: {
      customer: {name: 'Ada'},
      order: {
        number: '2026-00481',
        total: '12 500 FCFA',
        items: ['Pain complet', 'Croissant x4']
      }
    }
  })
};

fetch('https://api.lekalao.com/v1/transactional-mails/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lekalao.com/v1/transactional-mails/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'template' => 'confirmation-commande',
    'to' => [
        'ada@example.com'
    ],
    'locale' => 'fr',
    'variables' => [
        'customer' => [
                'name' => 'Ada'
        ],
        'order' => [
                'number' => '2026-00481',
                'total' => '12 500 FCFA',
                'items' => [
                                'Pain complet',
                                'Croissant x4'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://api.lekalao.com/v1/transactional-mails/send"

payload = {
    "template": "confirmation-commande",
    "to": ["ada@example.com"],
    "locale": "fr",
    "variables": {
        "customer": { "name": "Ada" },
        "order": {
            "number": "2026-00481",
            "total": "12 500 FCFA",
            "items": ["Pain complet", "Croissant x4"]
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "sandbox": true,
    "failure_reason": "<string>",
    "failure_code": "recipients_suppressed",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z",
    "bounced_at": "2023-11-07T05:31:56Z",
    "complained_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "e3b0c442-98fc-4c14-9a1e-2f6b7d8a9c10",
    "template": "confirmation-commande",
    "subject": "Commande 2026-00481 confirmée",
    "from": "bonjour@maboulangerie.example",
    "to": [
      "ada@example.com"
    ],
    "cc": [],
    "bcc": [],
    "status": "pending",
    "failure_reason": null,
    "opens": 0,
    "clicks": 0,
    "sent_at": null,
    "created_at": "2026-09-17T10:14:02+00:00"
  }
}

{
  "message": "La clé d’idempotence est trop longue.",
  "code": "idempotency_key_too_long",
  "doc_url": "https://docs.lekalao.com/fr/errors#idempotency_key_too_long"
}

{
  "message": "Non authentifié.",
  "code": "unauthenticated",
  "doc_url": "https://docs.lekalao.com/fr/errors#unauthenticated"
}

{
  "message": "Cette équipe est suspendue. Contactez le support.",
  "code": "team_suspended",
  "doc_url": "https://docs.lekalao.com/fr/errors#team_suspended"
}

{
  "message": "Une requête portant cette clé d’idempotence est déjà en cours.",
  "code": "idempotency_key_in_use",
  "doc_url": "https://docs.lekalao.com/fr/errors#idempotency_key_in_use"
}

{
  "message": "Non envoyé : ada@example.com figure sur la liste de suppression.",
  "code": "recipients_suppressed",
  "doc_url": "https://docs.lekalao.com/fr/errors#recipients_suppressed"
}

{
  "message": "<string>",
  "code": "recipients_suppressed",
  "doc_url": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "sandbox": true,
    "failure_reason": "<string>",
    "failure_code": "recipients_suppressed",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z",
    "bounced_at": "2023-11-07T05:31:56Z",
    "complained_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "code": "recipients_suppressed",
  "doc_url": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "sandbox": true,
    "failure_reason": "<string>",
    "failure_code": "recipients_suppressed",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z",
    "bounced_at": "2023-11-07T05:31:56Z",
    "complained_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Présentation

Listes

Abonnés

Tags

Segments

Imports

Modèles

Campagnes

Automatisations

E-mails transactionnels

Revenu

Champs de contact

Événements

Webhooks

Plateforme

Envoyer un e-mail transactionnel

Autorisations

En-têtes

Corps

Réponse