Créer un broadcast avec l'API Kit

Crée un e-mail broadcast en brouillon, ou le programme quand send_at est défini. Il part à tous les abonnés, ou seulement aux segments et tags de subscriber_filter. Renvoie le broadcast avec son id.

Identifiant
kit_create_broadcast

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "subject": "<subject>",
    "content": "<content>"
  }
}

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
subjectstringOuiSubject line of the email.
contentstringOuiBody of the email as HTML. On a Classic template, the template adds its design around this body.
preview_textstringNonPreview text shown after the subject in the inbox.
descriptionstringNonInternal description of the broadcast, not shown to the subscribers.
send_atstringNonWhen to send, in ISO 8601, for example 2026-11-02T13:00:00-03:00. Without a time zone it is UTC. It schedules the sending; omit it to keep a draft.
email_addressstringNonSending address of the account to send from. The default sending address of the account when omitted.
email_template_idintegerNonID of the email template, as the email_template id of a broadcast in List broadcasts. The default template of the account when omitted. Starting point templates do not work.
publicbooleanNontrue also publishes the broadcast on the web, in the newsletter feed of the Creator Profile and landing pages.
subscriber_filterarrayNonWho receives the broadcast: one object with exactly one of all, any or none. Omit it to send to every subscriber.

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