Lister les contacts avec l'API Mailjet
Liste les contacts du compte avec email, nom, statut d'exclusion et dates d'activité, éventuellement seulement ceux d'une liste. La réponse contient Data, Count et Total ; paginez avec Limit et Offset.
- Identifiant
- mailjet_list_contacts
L'appel
POST https://connect.reportei.com/api/tools/mailjet_list_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"ContactsList": 1
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| ContactsList | integer | Non | Only the contacts of this list, by the ID from List contact lists. |
| Campaign | integer | Non | Only the contacts targeted by this campaign, by the CampaignID that List campaign drafts returns for a sent draft. |
| IsExcludedFromCampaigns | boolean | Non | true returns only the contacts excluded from marketing emails, false leaves them out. |
| Limit | integer | Non | Contacts per page, up to 1000. The default is 10. |
| Offset | integer | Non | Index of the first contact of the page. The default is 0. |
| Sort | string | Non | Property and order separated by a space, for example ID DESC for the newest first. Not every property can sort. |
Connexions possibles
Votre client connecte son compte Mailjet une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Identifiant et mot de passe
Votre client saisit les identifiants de l'app sur un écran de Connect, ou votre système les envoie avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/mailjet_list_contacts. Il devient la définition de tool de votre agent sans conversion.
Autres tools Mailjet
- Obtenir un contactGETRenvoie un contact, trouvé par son ID ou son adresse email, avec nom, statut d'exclusion et dates d'activité. Utilisez-le pour obtenir l'ID d'un contact que vous ne connaissez que par son email.
- Mettre à jour un contactPUTModifie le nom d'un contact ou son exclusion des emails marketing. Seuls les champs envoyés changent. Un contact exclu reçoit toujours les emails transactionnels.
- Lister les listes de contactsGETListe les listes de contacts avec ID, nom, nombre d'abonnés et statut de suppression. La réponse contient Data, Count et Total ; paginez avec Limit et Offset.
- Créer une liste de contactsPOSTCrée une liste de contacts vide et la renvoie avec son ID.
- Gérer un contact de listePOSTAjoute un contact à une liste par email, en créant le contact quand l'email est nouveau et en définissant son nom et ses propriétés, ou le désabonne ou le retire de la liste, selon Action.
- Lister les propriétés de contactGETListe les propriétés de contact du compte avec nom, type de données et namespace. Les noms sont les clés de Properties dans Manage list contact. La réponse contient Data, Count et Total ; paginez avec Limit et Offset.
- Lister les expéditeursGETListe les adresses et domaines expéditeurs du compte avec ID, email, nom et statut. Seul un expéditeur Active peut envoyer une campagne. La réponse contient Data, Count et Total ; paginez avec Limit et Offset.
- Lister les modèlesGETListe les modèles d'email avec ID, nom, usages et mode d'édition. L'ID relie un modèle à un brouillon de campagne comme contenu. La réponse contient Data, Count et Total ; paginez avec Limit et Offset.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
