Lister les broadcasts avec l'API Kit

Liste les broadcasts avec id, objet, contenu, statut, send_at, ciblage et modèle d'e-mail. La réponse contient broadcasts et pagination ; tant que has_next_page vaut true, passez pagination.end_cursor en after.

Identifiant
kit_list_broadcasts

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "status": "draft"
  }
}

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
statusstringNonOnly the broadcasts in this status.Valeurs : draft, scheduled, sending, completed, aborted
sent_afterstringNonOnly the broadcasts sent after this date, as YYYY-MM-DD.
sent_beforestringNonOnly the broadcasts sent before this date, as YYYY-MM-DD.
per_pageintegerNonBroadcasts per page, up to 1000. The default is 500.
afterstringNonThe pagination.end_cursor of the previous page.

Connexions possibles

Votre client connecte son compte Kit une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/kit, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

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/kit_list_broadcasts. Il devient la définition de tool de votre agent sans conversion.

Autres tools Kit

Voir les 13 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.