Aller au contenu
Docs

Ajoutez, mettez à jour et retirez les abonnés d’une liste.

URL de basehttps://api.emailit.com/v2AuthentificationErreursLimites de débit

Ajouter un abonné

Ajoute un contact à une liste de contacts à partir de son adresse e-mail.

POST/audiences/{audience_id}/subscribers

Nécessite une clé API full. Si aucun contact n’a encore cette adresse e-mail, Emailit en crée un. Si le contact existe, les noms et les champs personnalisés que vous envoyez remplacent ses valeurs actuelles. Un contact qui s’était désinscrit de la liste est réinscrit et la réponse est 200 ; un contact déjà abonné renvoie 409.

Chaque liste peut contenir autant d’abonnés que votre forfait le permet ; au-delà, la requête renvoie 422 avec votre usage. Déclenche subscriber.created, ou subscriber.updated et subscriber.resubscribed en cas de réinscription.

Paramètres de chemin

audience_idstringobligatoire
L’ID de la liste (aud_…) ou son nom.

Paramètres du corps

emailstringobligatoire
L’adresse e-mail à inscrire. Enregistrée en minuscules.
first_namestring
Le prénom du contact.
last_namestring
Le nom de famille du contact.
custom_fieldsobject

Valeurs des champs personnalisés par clé, par exemple {"company": "Analytical Engines"}. Remplacent les champs personnalisés existants du contact.

Réponse

Renvoie 201 avec l’objet abonné, ou 200 lorsqu’un contact désinscrit a été réinscrit.

POST/audiences/{audience_id}/subscribers
Terminal
curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ada@example.com",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "custom_fields": { "company": "Analytical Engines" }
  }'
JSON
{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "custom_fields": {
    "company": "Analytical Engines"
  },
  "subscribed": true,
  "subscribed_at": "2026-10-01T10:20:31.000000Z",
  "unsubscribed_at": null,
  "created_at": "2026-10-01T10:20:31.000000Z",
  "updated_at": "2026-10-01T10:20:31.000000Z"
}

Récupérer un abonné

Récupère l’inscription d’un contact à une liste de contacts.

GET/audiences/{audience_id}/subscribers/{id}

Nécessite une clé API full. Un abonné relie un contact à une liste. L’adresse e-mail, les noms et les champs personnalisés appartiennent au contact, tandis que subscribed ne concerne que cette liste.

Paramètres de chemin

audience_idstringobligatoire
L’ID de la liste (aud_…) ou son nom.
idstringobligatoire
L’ID de l’abonné (sub_…) ou l’adresse e-mail du contact, encodée pour l’URL.

Réponse

Renvoie l’objet abonné.

objectstring
Toujours subscriber.
idstring
L’ID de l’abonné.
audience_idstring
L’ID de la liste.
contact_idstring
L’ID du contact.
emailstring
L’adresse e-mail du contact.
first_namestring | null
Le prénom du contact.
last_namestring | null
Le nom de famille du contact.
custom_fieldsobject | null
Les valeurs des champs personnalisés du contact.
subscribedboolean
true si le contact est abonné à cette liste, false s’il s’est désinscrit.
subscribed_atstring | null
Date de la dernière inscription du contact.
unsubscribed_atstring | null
Date de désinscription du contact, ou null.
created_atstring
Date à laquelle le contact a rejoint la liste.
updated_atstring
Date de la dernière modification de l’inscription.
GET/audiences/{audience_id}/subscribers/{id}
Terminal
curl https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers/sub_4KECYl5AwXEy8ezswYRhuddttxo \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "custom_fields": {
    "company": "Analytical Engines"
  },
  "subscribed": true,
  "subscribed_at": "2026-10-01T10:20:31.000000Z",
  "unsubscribed_at": null,
  "created_at": "2026-10-01T10:20:31.000000Z",
  "updated_at": "2026-10-01T10:20:31.000000Z"
}

Mettre à jour un abonné

Modifie le statut d’un abonné dans la liste de contacts, ou les informations de son contact.

POST/audiences/{audience_id}/subscribers/{id}

Nécessite une clé API full. N’envoyez que les champs à modifier. subscribed ne s’applique qu’à cette liste. email, first_name, last_name et custom_fields modifient le contact lui-même : la modification apparaît donc dans toutes les listes auxquelles le contact appartient. Déclenche l’événement subscriber.updated.

Paramètres de chemin

audience_idstringobligatoire
L’ID de la liste (aud_…) ou son nom.
idstringobligatoire
L’ID de l’abonné (sub_…) ou l’adresse e-mail du contact, encodée pour l’URL.

Paramètres du corps

subscribedboolean
false pour désinscrire le contact de cette liste, true pour le réinscrire. Dans les deux cas, l’abonné reste dans la liste.
emailstring
Une nouvelle adresse e-mail pour le contact. Enregistrée en minuscules.
first_namestring
Le prénom du contact.
last_namestring
Le nom de famille du contact.
custom_fieldsobject
Valeurs des champs personnalisés par clé. Remplacent les champs personnalisés existants du contact.

Réponse

Renvoie l’objet abonné mis à jour. Une requête sans aucun de ces champs renvoie 400.

POST/audiences/{audience_id}/subscribers/{id}
Terminal
curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers/sub_4KECYl5AwXEy8ezswYRhuddttxo \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"first_name": "Augusta"}'
Terminal
curl -X POST https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers/ada%40example.com \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subscribed": false}'
JSON
{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "custom_fields": {
    "company": "Analytical Engines"
  },
  "subscribed": false,
  "subscribed_at": "2026-10-01T10:20:31.000000Z",
  "unsubscribed_at": "2026-10-02T08:14:55.000000Z",
  "created_at": "2026-10-01T10:20:31.000000Z",
  "updated_at": "2026-10-02T08:14:55.000000Z"
}

Lister les abonnés

Renvoie une page des abonnés d’une liste de contacts, du plus récent au plus ancien.

GET/audiences/{audience_id}/subscribers

Nécessite une clé API full. La liste renvoyée inclut les contacts qui se sont désinscrits de la liste, sauf si vous les excluez avec subscribed=true.

Paramètres de chemin

audience_idstringobligatoire
L’ID de la liste (aud_…) ou son nom.

Paramètres de requête

pageintegerpar défaut : 1
La page à renvoyer.
limitintegerpar défaut : 25
Nombre d’abonnés par page, de 1 à 100. per_page fonctionne aussi.
subscribedstring
true pour les contacts abonnés uniquement, false pour les contacts désinscrits uniquement.
matchstringpar défaut : all
all ou or. Mode de combinaison des filtres ci-dessous.
orderstring
Une clé de filtre selon laquelle trier.
directionstring
asc ou desc.

Filtres

Ajoutez des filtres sous la forme key.condition=value, par exemple email.ends_with=@acme.com. Consultez Filtrage et tri.

Clé Type Remarques
email chaîne
first_name chaîne
last_name chaîne
subscribed booléen
created_at date Date à laquelle le contact a rejoint la liste.

Chaque clé est aussi une clé de tri.

Réponse

dataobject[]
Les objets abonné de cette page.
next_page_urlstring | null
Chemin de la page suivante, ou null. Il conserve subscribed, mais pas vos autres filtres. Consultez Pagination.
previous_page_urlstring | null
Chemin de la page précédente, ou null.
usageobject
used (abonnés de la liste), limit (le maximum autorisé par liste sur votre forfait, ou null) et plan.
GET/audiences/{audience_id}/subscribers
Terminal
curl https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
Terminal
curl -G https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -d subscribed=true \
  -d limit=100
JSON
{
  "data": [
    {
      "object": "subscriber",
      "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
      "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
      "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      },
      "subscribed": true,
      "subscribed_at": "2026-10-01T10:20:31.000000Z",
      "unsubscribed_at": null,
      "created_at": "2026-10-01T10:20:31.000000Z",
      "updated_at": "2026-10-01T10:20:31.000000Z"
    },
    {
      "object": "subscriber",
      "id": "sub_4KnmYprkoMRytdkm3tAHIfPW0Vh",
      "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
      "contact_id": "con_4KiXIs4xLTcJIAHnKJaLcnMZYh7",
      "email": "grace@example.com",
      "first_name": "Grace",
      "last_name": "Hopper",
      "custom_fields": null,
      "subscribed": false,
      "subscribed_at": "2026-09-28T07:55:02.000000Z",
      "unsubscribed_at": "2026-09-30T18:11:40.000000Z",
      "created_at": "2026-09-28T07:55:02.000000Z",
      "updated_at": "2026-09-30T18:11:40.000000Z"
    }
  ],
  "next_page_url": null,
  "previous_page_url": null,
  "usage": {
    "used": 2,
    "limit": 50000,
    "plan": "pro"
  }
}

Supprimer un abonné

Retire un contact d’une liste de contacts.

DELETE/audiences/{audience_id}/subscribers/{id}

Nécessite une clé API full. Le contact lui-même n’est pas supprimé et reste dans ses autres listes. Pour garder une trace de la désinscription d’une personne, désinscrivez-la plutôt avec subscribed: false. Déclenche l’événement subscriber.deleted.

Paramètres de chemin

audience_idstringobligatoire
L’ID de la liste (aud_…) ou son nom.
idstringobligatoire
L’ID de l’abonné (sub_…) ou l’adresse e-mail du contact, encodée pour l’URL.

Réponse

objectstring
Toujours subscriber.
idstring
L’ID de l’abonné supprimé.
audience_idstring
L’ID de la liste.
contact_idstring
L’ID du contact.
emailstring
L’adresse e-mail du contact.
deletedboolean
Toujours true.
DELETE/audiences/{audience_id}/subscribers/{id}
Terminal
curl -X DELETE https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers/sub_4KECYl5AwXEy8ezswYRhuddttxo \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "object": "subscriber",
  "id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
  "audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
  "contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
  "email": "ada@example.com",
  "deleted": true
}

Cette page vous a-t-elle été utile ?

Merci pour votre retour.

Merci, nous lisons chaque message.