Passer au contenu principal
L’API couvre le chemin le plus courant : votre outil rédige le contenu, Lekalao l’envoie. Les réglages fins (segment, A/B test, planification, expéditeur propre à la campagne) se font dans l’interface.

Créer

La campagne est créée en brouillon, pour toute la liste, avec l’expéditeur de la liste.
Le contenu doit contenir {{ unsubscribe_url }} et {{ organisation.address }}, directement ou par son modèle. Sans eux, la campagne ne partira pas.

Tester

Jusqu’à 5 adresses. L’objet est préfixé par « [Test] » ; les abonnés et les statistiques ne sont pas touchés :
Un test passe par les mêmes vérifications que tout e-mail, et chaque adresse compte dans le quota du mois. Les adresses de la liste de suppression sont retirées ; recipients dit à qui il est parti. Il est refusé par un 422 test_refused, la raison dans message, quand :
  • le domaine de l’expéditeur n’est pas vérifié, là où l’installation l’exige ;
  • toutes les adresses données sont sur la liste de suppression ;
  • l’équipe a envoyé 100 e-mails de test dans l’heure, toutes campagnes confondues ;
  • le quota du mois est épuisé.
Avec une clé de test, chaque vérification est faite et la campagne rendue, puis rien ne part et rien n’est compté : "sandbox": true.

Envoyer

Si tout est prêt, l’envoi démarre immédiatement :
Sinon, 422 campaign_not_ready avec la liste de ce qui manque, les mêmes vérifications que dans l’interface (Envoyer) :
Une clé de test ne peut pas envoyer de campagne : 403 sandbox_cannot_send.
L’envoi est définitif. Utilisez une Idempotency-Key : un appel répété après une coupure réseau ne relancera pas l’envoi.

Suivre

Les chiffres sont recalculés chaque minute. delivered n’est rempli que si le fournisseur envoie ses retours. Le webhook campaign.sent prévient quand l’envoi est terminé. GET /v1/campaigns?status=sent&list={id} liste les campagnes, les plus récentes d’abord.

Supprimer

DELETE /v1/campaigns/{id} supprime une campagne et ses statistiques. 409 pendant un envoi : mettez-la en pause dans l’interface d’abord.

Modèles

Pour que votre CMS n’envoie que le corps de l’e-mail, préparez un modèle avec l’en-tête, le pied, le lien de désabonnement et l’adresse postale. Les modèles se gèrent aussi par l’API : GET|POST /templates, GET|PUT|DELETE /templates/{id}.