Abonnés
Ajoutez, mettez à jour et retirez les abonnés d’une liste.
Ajouter un abonné
Ajoute un contact à une liste de contacts à partir de son adresse e-mail.
/audiences/{audience_id}/subscribersNé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_idstringobligatoireaud_…) ou son nom.Paramètres du corps
emailstringobligatoirefirst_namestringlast_namestringcustom_fieldsobjectValeurs 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.
{
"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"
}{
"error": "Audience not found"
}{
"error": "Contact is already subscribed to this audience",
"existing": {
"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.000Z",
"unsubscribed_at": null,
"created_at": "2026-10-01T10:20:31.000Z",
"updated_at": "2026-10-01T10:20:31.000Z"
}
}{
"error": "Pro includes 50,000 subscribers per audience.",
"usage": {
"used": 50000,
"limit": 50000,
"plan": "pro"
}
}Récupérer un abonné
Récupère l’inscription d’un contact à une liste de contacts.
/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_idstringobligatoireaud_…) ou son nom.idstringobligatoiresub_…) ou l’adresse e-mail du contact, encodée pour l’URL.Réponse
Renvoie l’objet abonné.
objectstringsubscriber.idstringaudience_idstringcontact_idstringemailstringfirst_namestring | nulllast_namestring | nullcustom_fieldsobject | nullsubscribedbooleantrue si le contact est abonné à cette liste, false s’il s’est désinscrit.subscribed_atstring | nullunsubscribed_atstring | nullnull.created_atstringupdated_atstring{
"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"
}{
"error": "Subscriber not found"
}Mettre à jour un abonné
Modifie le statut d’un abonné dans la liste de contacts, ou les informations de son contact.
/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_idstringobligatoireaud_…) ou son nom.idstringobligatoiresub_…) ou l’adresse e-mail du contact, encodée pour l’URL.Paramètres du corps
subscribedbooleanfalse pour désinscrire le contact de cette liste, true pour le réinscrire. Dans les deux cas, l’abonné reste dans la liste.emailstringfirst_namestringlast_namestringcustom_fieldsobjectRéponse
Renvoie l’objet abonné mis à jour. Une requête sans aucun de ces champs renvoie 400.
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}'{
"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"
}{
"error": "No valid fields provided for update. Provide at least one of: email, first_name, last_name, custom_fields, subscribed"
}{
"error": "Subscriber not found"
}Lister les abonnés
Renvoie une page des abonnés d’une liste de contacts, du plus récent au plus ancien.
/audiences/{audience_id}/subscribersNé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_idstringobligatoireaud_…) ou son nom.Paramètres de requête
pageintegerpar défaut : 1limitintegerpar défaut : 25per_page fonctionne aussi.subscribedstringtrue pour les contacts abonnés uniquement, false pour les contacts désinscrits uniquement.searchstringmatchstringpar défaut : allall ou or. Mode de combinaison des filtres ci-dessous.orderstringdirectionstringasc 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[]next_page_urlstring | nullnull. Il conserve subscribed, mais pas vos autres filtres. Consultez Pagination.previous_page_urlstring | nullnull.usageobjectused (abonnés de la liste), limit (le maximum autorisé par liste sur votre forfait, ou null) et plan.curl -G https://api.emailit.com/v2/audiences/aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2/subscribers \
-H "Authorization: Bearer $EMAILIT_API_KEY" \
-d subscribed=true \
-d limit=100{
"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"
}
}{
"error": "Audience not found"
}Supprimer un abonné
Retire un contact d’une liste de contacts.
/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_idstringobligatoireaud_…) ou son nom.idstringobligatoiresub_…) ou l’adresse e-mail du contact, encodée pour l’URL.Réponse
objectstringsubscriber.idstringaudience_idstringcontact_idstringemailstringdeletedbooleantrue.{
"object": "subscriber",
"id": "sub_4KECYl5AwXEy8ezswYRhuddttxo",
"audience_id": "aud_4KbFmQPy1feMCGAY8F8pAhiZ1u2",
"contact_id": "con_4K9kQdrXth7am0TPKvPrR5yd2oo",
"email": "ada@example.com",
"deleted": true
}{
"error": "Subscriber not found"
}