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. |
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.
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 |
Campagnes
Créez des campagnes, choisissez leurs listes de contacts, 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 |
| Supprimer une campagne | DELETE |
/campaigns/{id} |
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
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 |
|---|---|---|---|
| Lister les événements | GET |
/events |
full |
| Récupérer un événement | GET |
/events/{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 |