Lister les contacts avec l'API Omnisend
Liste les contacts avec id, email, phone, status, tags, segments et propriétés personnalisées, du plus récent au plus ancien par défaut. La réponse contient contacts et paging ; tant que paging.hasMore vaut true, passez paging.cursors.after comme after et gardez les filtres.
- Identifiant
- omnisend_list_contacts
L'appel
POST https://connect.reportei.com/api/tools/omnisend_list_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email": "<email>"
}
}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 |
|---|---|---|---|
| string | Non | Only the contact with this email address. | |
| phone | string | Non | Only the contact with this phone number, in E.164 format such as +5511999998888. |
| status | string | Non | Only the contacts with this email subscription status. Does not work together with tag.Valeurs : subscribed, unsubscribed, nonSubscribed |
| tag | string | Non | Only the contacts with this tag. Does not work together with status. |
| segmentID | string | Non | Only the contacts of this segment, by the segmentID from List segments. |
| updatedAtFrom | string | Non | Only the contacts updated at or after this RFC 3339 date-time. Does not work together with the other filters. |
| sort | string | Non | Field to sort by. The default is createdAt.Valeurs : createdAt, updatedAt |
| direction | string | Non | Order of the sort, used only with sort. The default is desc.Valeurs : asc, desc |
| limit | integer | Non | Contacts per page, up to 250. The default is 100. |
| after | string | Non | The paging.cursors.after of the previous page. |
Connexions possibles
Votre client connecte son compte Omnisend 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/omnisend_list_contacts. Il devient la définition de tool de votre agent sans conversion.
Autres tools Omnisend
- Créer un contactPOSTCrée un contact, ou met à jour le contact qui a déjà le même identifiant email. Mettre un canal à subscribed envoie le message de bienvenue de la marque, quand cette automatisation est active, sauf si sendWelcomeMessage vaut false.
- Modifier un contactPATCHMet à jour un contact. Seuls les champs envoyés changent, mais tags remplace toute la liste de tags : pour seulement ajouter des tags, utilisez Appliquer des tags. Un statut de canal dans identifiers abonne ou désabonne le contact.
- Appliquer des tagsPOSTAjoute des tags à des contacts, en gardant les tags qu'ils ont déjà. Choisissez les contacts par contactIDs, emails, phones ou segmentID ; les sélections s'additionnent. Limité à 60 appels par minute.
- Lister les segmentsGETListe les segments avec segmentID, name et status. Le segmentID cible les campagnes et filtre les contacts. La réponse contient segments et paging ; tant que paging.hasMore vaut true, passez paging.cursors.after comme after.
- Lister les modèles d'emailGETListe les modèles d'email avec id et name, du plus récent au plus ancien par défaut. L'id est le corps d'une campagne email. La réponse contient templates et paging ; tant que paging.hasMore vaut true, passez paging.cursors.after comme after.
- Lister les campagnesGETListe les campagnes avec id, name, status, channel, content, audience et réglages d'envoi, de la plus récente à la plus ancienne par défaut. La réponse contient campaigns et paging ; tant que paging.hasMore vaut true, passez paging.cursors.after comme after et gardez les filtres.
- Créer une campagnePOSTCrée une campagne email ou SMS classique en brouillon et la renvoie avec son id. Une campagne email a besoin de content.email.templateID, issu de Lister les modèles d'email, et une campagne SMS de content.sms. Rien n'est envoyé avant Envoyer une campagne.
- Modifier une campagnePATCHMet à jour une campagne au statut draft. Seuls les champs envoyés changent. Le modèle d'email reste celui défini à la création. Pour modifier une campagne qui n'est plus un brouillon, l'app demande une copie.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
