Lister les segments avec l'API Omnisend

Liste 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.

Identifiant
omnisend_list_segments

L'appel

POST https://connect.reportei.com/api/tools/omnisend_list_segments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "sort": "createdAt"
  }
}

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ètreTypeObligatoireDescription
sortstringNonField to sort by, on the first page only.Valeurs : createdAt, name
directionstringNonOrder of the sort, used only with sort.Valeurs : asc, desc
limitintegerNonSegments per page, up to 50.
afterstringNonThe 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_segments. Il devient la définition de tool de votre agent sans conversion.

Autres tools Omnisend

Voir les 14 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.