Lister les expéditeurs avec l'API GetResponse
Liste les adresses d'expéditeur du compte avec fromFieldId, email, nom, isActive et isDefault. Le fromFieldId va dans fromField et replyTo de Create newsletter. Paginez avec page et perPage.
- Identifiant
- getresponse_list_from_fields
L'appel
POST https://connect.reportei.com/api/tools/getresponse_list_from_fields/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"fields": "<fields>"
}
}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 |
|---|---|---|---|
| fields | string | Non | Fields to return, comma-separated, such as email,isDefault. fromFieldId always comes back. |
| perPage | integer | Non | Addresses per page, up to 1000. The default is 100. |
| page | integer | Non | Page number, starting at 1. |
Connexions possibles
Votre client connecte son compte GetResponse une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé 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/getresponse_list_from_fields. Il devient la définition de tool de votre agent sans conversion.
Autres tools GetResponse
- Rechercher des contactsPOSTRecherche les contacts d'une ou plusieurs campagnes (listes de contacts) par statut d'abonnement et, en option, par email ou nom. Les contacts en double opt-in non confirmés n'apparaissent qu'ici. Paginez avec page et perPage, jusqu'à 1000 ; une page plus courte que perPage est la dernière.
- Obtenir un contactGETRenvoie un contact actif avec email, nom, campagne, dayOfCycle, tags et customFieldValues. Un contact supprimé répond 404.
- Créer un contactPOSTAjoute un contact à une campagne (liste de contacts). GetResponse répond 202 sans corps et traite la demande dans une file qui peut prendre quelques minutes : retrouvez le contactId plus tard avec Search contacts. Dans une liste en double opt-in, la personne reçoit d'abord un email de confirmation. Un email déjà dans la liste répond 409.
- Mettre à jour un contactPOSTMet à jour un contact. Seuls les champs envoyés changent. Une campagne différente déplace le contact, avec son historique et ses statistiques, vers cette liste.
- Lister les campagnesGETListe les campagnes, qui sont les listes de contacts de GetResponse, avec campaignId, nom, languageCode et isDefault. Paginez avec page et perPage, jusqu'à 1000 ; une page plus courte que perPage est la dernière.
- Créer une campagnePOSTCrée une campagne, qui est une liste de contacts dans GetResponse, et la renvoie avec son campaignId. Un compte a jusqu'à 1000 listes, et un nom déjà utilisé répond 409.
- Lister les newslettersGETListe les newsletters, brouillons inclus, avec newsletterId, objet, type, campagne, sendOn et sendMetrics, qui contient delivered, openRate et clickRate. Paginez avec page et perPage, jusqu'à 1000 ; une page plus courte que perPage est la dernière.
- Obtenir une newsletterGETRenvoie une newsletter avec son contenu, fromField, campagne, sendSettings, sendOn et sendMetrics.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
