Créer
La campagne est créée en brouillon, pour toute la liste, avec l’expéditeur de la liste.
Tester
Jusqu’à 5 adresses. L’objet est préfixé par « [Test] » ; les abonnés et les statistiques ne sont pas touchés :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é.
"sandbox": true.
Envoyer
422 campaign_not_ready avec la liste de ce qui manque, les mêmes vérifications que dans l’interface (Envoyer) :
403 sandbox_cannot_send.
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}.