Référence
Tous les endpoints
Tous les endpoints de l’API Emailit v2 au même endroit, regroupés par ressource, avec leur méthode HTTP, leur chemin, la portée de clé API requise et un lien vers leur référence.
Cette page liste tous les endpoints de l’API Emailit, regroupés par ressource. Les chemins sont relatifs à l’URL de base https://api.emailit.com/v2, et {id} désigne l’ID de l’objet (ou, lorsque l’endpoint l’accepte, son nom ou son adresse e-mail).
La colonne Portée indique quelles clés API peuvent appeler l’endpoint :
| Portée | Fonctionne avec |
|---|---|
sending |
Les clés de portée sending ou full. |
events |
Les clés de portée events ou full. |
full |
Les clés de portée full uniquement. |
Les jetons d’accès OAuth suivent les mêmes règles que les clés API de même portée. OAuth n’a pas de portée events : les jetons ont donc besoin de full pour ces endpoints.
E-mails
Envoyez des e-mails, consultez les messages et leur contenu, et programmez, annulez, relancez ou transférez-les. Pour la référence complète, consultez E-mails.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Envoyer un e-mail | POST |
/emails |
sending |
| Lister les e-mails | GET |
/emails |
full |
| Récupérer un e-mail | GET |
/emails/{id} |
full |
| Récupérer le MIME brut | GET |
/emails/{id}/raw |
full |
| Lister les pièces jointes | GET |
/emails/{id}/attachments |
full |
| Récupérer le corps | GET |
/emails/{id}/body |
full |
| Récupérer les métadonnées | GET |
/emails/{id}/meta |
full |
| Mettre à jour un e-mail programmé | POST |
/emails/{id} |
sending |
| Annuler un e-mail | POST |
/emails/{id}/cancel |
sending |
| Relancer un e-mail | POST |
/emails/{id}/retry |
sending |
| Transférer un e-mail | POST |
/emails/{id}/forward |
sending |
| Récupérer uniquement le statut | GET |
/email/{id} |
full |
Domaines
Ajoutez des domaines d’envoi, consultez leurs enregistrements DNS et leur statut de vérification, et vérifiez-les. Pour la référence complète, consultez Domaines.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un domaine | POST |
/domains |
full |
| Récupérer un domaine | GET |
/domains/{id} |
full |
| Vérifier un domaine | POST |
/domains/{id}/verify |
full |
| Mettre à jour un domaine | POST |
/domains/{id} |
full |
| Lister les domaines | GET |
/domains |
full |
| Supprimer un domaine | DELETE |
/domains/{id} |
full |
Rapports DMARC
Consultez les rapports DMARC agrégés et forensiques d’un domaine d’envoi, ou importez les vôtres. Pour la référence complète, consultez Rapports DMARC.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Lister les rapports agrégés | GET |
/domains/{id}/dmarc/reports |
full |
| Récupérer un rapport | GET |
/domains/{id}/dmarc/reports/{report_id} |
full |
| Importer un rapport | POST |
/domains/{id}/dmarc/reports |
full |
| Lister les rapports forensiques | GET |
/domains/{id}/dmarc/forensic |
full |
| Récupérer un rapport forensique | GET |
/domains/{id}/dmarc/forensic/{report_id} |
full |
| Récupérer les statistiques | GET |
/domains/{id}/dmarc/stats |
full |
| Lister les sources d’envoi | GET |
/domains/{id}/dmarc/sources |
full |
| Lister les pays | GET |
/domains/{id}/dmarc/countries |
full |
| Lister les réseaux (ASN) | GET |
/domains/{id}/dmarc/asns |
full |
| Lister les émetteurs de rapports | GET |
/domains/{id}/dmarc/reporters |
full |
Clés API
Créez, listez, renommez et révoquez les clés API d’un espace de travail. Pour la référence complète, consultez Clés API.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer une clé API | POST |
/api-keys |
full |
| Récupérer une clé API | GET |
/api-keys/{id} |
full |
| Lister les clés API | GET |
/api-keys |
full |
| Mettre à jour une clé API | POST |
/api-keys/{id} |
full |
| Régénérer une clé API | POST |
/api-keys/{id}/regenerate |
full |
| Supprimer une clé API | DELETE |
/api-keys/{id} |
full |
Listes de contacts
Gérez les listes d’abonnés utilisées par les campagnes et les formulaires d’inscription. Pour la référence complète, consultez Listes de contacts.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer une liste de contacts | POST |
/audiences |
full |
| Récupérer une liste de contacts | GET |
/audiences/{id} |
full |
| Mettre à jour une liste de contacts | POST |
/audiences/{id} |
full |
| Lister les listes de contacts | GET |
/audiences |
full |
| Supprimer une liste de contacts | DELETE |
/audiences/{id} |
full |
Abonnés
Ajoutez, mettez à jour et retirez les abonnés d’une liste de contacts. Pour la référence complète, consultez Abonnés.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Ajouter un abonné | POST |
/audiences/{audience_id}/subscribers |
full |
| Récupérer un abonné | GET |
/audiences/{audience_id}/subscribers/{id} |
full |
| Mettre à jour un abonné | POST |
/audiences/{audience_id}/subscribers/{id} |
full |
| Lister les abonnés | GET |
/audiences/{audience_id}/subscribers |
full |
| Supprimer un abonné | DELETE |
/audiences/{audience_id}/subscribers/{id} |
full |
Contacts
Gérez les profils de contacts et les champs personnalisés, en masse ou un par un. Pour la référence complète, consultez Contacts.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un contact | POST |
/contacts |
full |
| Récupérer un contact | GET |
/contacts/{id} |
full |
| Mettre à jour un contact | POST |
/contacts/{id} |
full |
| Lister les contacts | GET |
/contacts |
full |
| Mettre à jour des contacts en masse | POST |
/contacts/bulk |
full |
| Exporter des contacts | GET, POST |
/contacts/export |
full |
| Supprimer un contact | DELETE |
/contacts/{id} |
full |
Segments
Enregistrez des filtres sur vos contacts, listez ceux qui correspondent et suivez l’évolution des segments avec suivi. Pour la référence complète, consultez Segments.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un segment | POST |
/segments |
full |
| Récupérer un segment | GET |
/segments/{id} |
full |
| Mettre à jour un segment | POST |
/segments/{id} |
full |
| Lister les segments | GET |
/segments |
full |
| Supprimer un segment | DELETE |
/segments/{id} |
full |
| Lister les contacts d’un segment | GET |
/segments/{id}/contacts |
full |
| Récupérer l’évolution d’un segment | GET |
/segments/{id}/growth |
full |
| Prévisualiser un segment | POST |
/segments/preview |
full |
| Lister les champs de segment | GET |
/segments/fields |
full |
Campagnes
Créez des campagnes, choisissez leurs listes de contacts et leurs segments, puis envoyez-les ou programmez-les. Pour la référence complète, consultez Campagnes.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer une campagne | POST |
/campaigns |
full |
| Récupérer une campagne | GET |
/campaigns/{id} |
full |
| Mettre à jour une campagne | POST |
/campaigns/{id} |
full |
| Lister les campagnes | GET |
/campaigns |
full |
| Envoyer ou programmer une campagne | POST |
/campaigns/{id}/send |
full |
| Annuler une campagne | POST |
/campaigns/{id}/cancel |
full |
| Récupérer les statistiques d’une campagne | GET |
/campaigns/{id}/stats |
full |
| Supprimer une campagne | DELETE |
/campaigns/{id} |
full |
Produits
Gardez le catalogue de votre boutique dans Emailit pour les grilles de produits, les recommandations et les articles des commandes. Pour la référence complète, consultez Produits. En bêta sur les forfaits Pro, Business et Contract. Consultez Qui peut utiliser Commerce.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer ou mettre à jour un produit | POST |
/products |
events |
| Récupérer un produit | GET |
/products/{id} |
full |
| Mettre à jour un produit | POST |
/products/{id} |
events |
| Lister les produits | GET |
/products |
full |
| Créer ou mettre à jour des produits par lots | POST |
/products/batch |
events |
| Lister les catégories de produits | GET |
/products/categories |
full |
| Supprimer un produit | DELETE |
/products/{id} |
full |
Commandes
Envoyez les commandes de votre boutique pour attribuer le chiffre d’affaires aux e-mails et construire les profils d’achat. Pour la référence complète, consultez Commandes. En bêta sur les forfaits Pro, Business et Contract. Consultez Qui peut utiliser Commerce.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer ou mettre à jour une commande | POST |
/orders |
events |
| Récupérer une commande | GET |
/orders/{id} |
full |
| Mettre à jour une commande | POST |
/orders/{id} |
events |
| Lister les commandes | GET |
/orders |
full |
| Importer des commandes par lots | POST |
/orders/batch |
events |
| Supprimer une commande | DELETE |
/orders/{id} |
full |
Paniers
Envoyez les paniers de vos acheteurs pour qu’Emailit détecte les paniers abandonnés. Pour la référence complète, consultez Paniers. En bêta sur les forfaits Pro, Business et Contract. Consultez Qui peut utiliser Commerce.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer ou mettre à jour un panier | POST |
/carts |
events |
| Récupérer un panier | GET |
/carts/{id} |
full |
| Lister les paniers | GET |
/carts |
full |
| Supprimer un panier | DELETE |
/carts/{id} |
full |
Coupons
Créez des coupons et gérez leurs réserves de codes uniques pour vos e-mails. Pour la référence complète, consultez Coupons. En bêta sur les forfaits Pro, Business et Contract. Consultez Qui peut utiliser Commerce.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un coupon | POST |
/coupons |
full |
| Récupérer un coupon | GET |
/coupons/{id} |
full |
| Mettre à jour un coupon | POST |
/coupons/{id} |
full |
| Lister les coupons | GET |
/coupons |
full |
| Supprimer un coupon | DELETE |
/coupons/{id} |
full |
| Lister les codes d’un coupon | GET |
/coupons/{id}/codes |
full |
| Ajouter des codes à un coupon | POST |
/coupons/{id}/codes |
full |
E-commerce
Les paramètres Commerce, la vue d’ensemble du chiffre d’affaires et le profil d’achat d’un contact. Pour la référence complète, consultez E-commerce. En bêta sur les forfaits Pro, Business et Contract. Consultez Qui peut utiliser Commerce.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Récupérer les paramètres Commerce | GET |
/commerce/settings |
full |
| Mettre à jour les paramètres Commerce | POST |
/commerce/settings |
full |
| Récupérer la vue d’ensemble Commerce | GET |
/commerce/overview |
full |
| Récupérer le profil d’achat d’un contact | GET |
/contacts/{id}/commerce |
full |
Automatisations
Construisez des workflows à partir de déclencheurs et d’étapes, exécutez-les et examinez leurs exécutions. Pour la référence complète, consultez Automatisations.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer une automatisation | POST |
/automations |
full |
| Récupérer une automatisation | GET |
/automations/{id} |
full |
| Mettre à jour une automatisation | POST |
/automations/{id} |
full |
| Lister les automatisations | GET |
/automations |
full |
| Supprimer une automatisation | DELETE |
/automations/{id} |
full |
| Démarrer une automatisation | POST |
/automations/{id}/start |
full |
| Mettre en pause une automatisation | POST |
/automations/{id}/pause |
full |
| Arrêter une automatisation | POST |
/automations/{id}/stop |
full |
| Déclencher une exécution | POST |
/automations/{id}/trigger |
full |
| Lister les exécutions | GET |
/automations/{id}/runs |
full |
| Récupérer une exécution | GET |
/automations/{id}/runs/{run_id} |
full |
| Récupérer les statistiques | GET |
/automations/{id}/stats |
full |
| Récupérer les statistiques d’une étape | GET |
/automations/{id}/steps/{step_key}/stats |
full |
Formulaires
Créez des formulaires d’inscription, publiez-les et effectuez la rotation de leur jeton public. Pour la référence complète, consultez Formulaires.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un formulaire | POST |
/forms |
full |
| Récupérer un formulaire | GET |
/forms/{id} |
full |
| Mettre à jour un formulaire | POST |
/forms/{id} |
full |
| Lister les formulaires | GET |
/forms |
full |
| Publier un formulaire | POST |
/forms/{id}/publish |
full |
| Dépublier un formulaire | POST |
/forms/{id}/unpublish |
full |
| Réinitialiser le jeton public | POST |
/forms/{id}/reset-token |
full |
| Supprimer un formulaire | DELETE |
/forms/{id} |
full |
Modèles
Créez des versions de modèle, publiez-en une par alias et utilisez-les pour vos envois. Pour la référence complète, consultez Modèles.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un modèle | POST |
/templates |
full |
| Récupérer un modèle | GET |
/templates/{id} |
full |
| Mettre à jour un modèle | POST |
/templates/{id} |
full |
| Lister les modèles | GET |
/templates |
full |
| Publier un modèle | POST |
/templates/{id}/publish |
full |
| Supprimer un modèle | DELETE |
/templates/{id} |
full |
Adresses bloquées
Consultez et gérez les adresses auxquelles Emailit n’enverra pas d’e-mails. Pour la référence complète, consultez Adresses bloquées.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un blocage | POST |
/suppressions |
full |
| Récupérer un blocage | GET |
/suppressions/{id} |
full |
| Mettre à jour un blocage | POST |
/suppressions/{id} |
full |
| Lister les adresses bloquées | GET |
/suppressions |
full |
| Supprimer un blocage | DELETE |
/suppressions/{id} |
full |
Webhooks
Enregistrez des endpoints qui reçoivent des notifications d’événements signées. Pour la référence complète, consultez Webhooks.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un webhook | POST |
/webhooks |
full |
| Récupérer un webhook | GET |
/webhooks/{id} |
full |
| Mettre à jour un webhook | POST |
/webhooks/{id} |
full |
| Lister les webhooks | GET |
/webhooks |
full |
| Supprimer un webhook | DELETE |
/webhooks/{id} |
full |
| Envoyer un événement de test | POST |
/webhooks/{id}/test |
full |
| Effectuer une rotation du secret de signature | POST |
/webhooks/{id}/reset-secret |
full |
| Relancer les requêtes en échec | POST |
/webhooks/{id}/retry-failed |
full |
| Relancer une requête | POST |
/webhooks/{id}/requests/{request_id}/retry |
full |
Événements
Envoyez des événements d’espace de travail et des événements personnalisés, et consultez le flux d’événements qui alimente les webhooks : livraisons, rebonds, ouvertures et plus encore. Pour la référence complète, consultez Événements.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Envoyer un événement | POST |
/events |
events |
| Envoyer des événements par lot | POST |
/events/batch |
events |
| Lister les événements | GET |
/events |
full |
| Récupérer un événement | GET |
/events/{id} |
full |
Événements d’espace de travail
Définissez des événements d’espace de travail et les types de leurs propriétés. Pour la référence complète, consultez Événements d’espace de travail.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer un événement d’espace de travail | POST |
/workspace/events |
full |
| Récupérer un événement d’espace de travail | GET |
/workspace/events/{id} |
full |
| Mettre à jour un événement d’espace de travail | POST |
/workspace/events/{id} |
full |
| Lister les événements d’espace de travail | GET |
/workspace/events |
full |
| Supprimer un événement d’espace de travail | DELETE |
/workspace/events/{id} |
full |
Clés de suivi
Gérez les clés publiques du script de suivi. Pour la référence complète, consultez Clés de suivi.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer une clé de suivi | POST |
/tracking-keys |
full |
| Récupérer une clé de suivi | GET |
/tracking-keys/{id} |
full |
| Mettre à jour une clé de suivi | POST |
/tracking-keys/{id} |
full |
| Lister les clés de suivi | GET |
/tracking-keys |
full |
| Supprimer une clé de suivi | DELETE |
/tracking-keys/{id} |
full |
Vérification d’e-mails
Vérifiez une adresse en temps réel. Pour la référence complète, consultez Vérification d’e-mails.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Vérifier une adresse | POST |
/email-verifications |
full |
Listes de vérification
Vérifiez jusqu’à 10 000 adresses à la fois et exportez les résultats. Pour la référence complète, consultez Listes de vérification.
| Endpoint | Méthode | Chemin | Portée |
|---|---|---|---|
| Créer une liste | POST |
/email-verification-lists |
full |
| Lister les listes | GET |
/email-verification-lists |
full |
| Récupérer une liste | GET |
/email-verification-lists/{id} |
full |
| Lister les résultats | GET |
/email-verification-lists/{id}/results |
full |
| Exporter les résultats | GET |
/email-verification-lists/{id}/export |
full |