Crear broadcast en Kit, con una API

Crea un email broadcast como borrador, o lo programa cuando send_at está definido. Va a todos los suscriptores, o solo a los segmentos y tags de subscriber_filter. Devuelve el broadcast con su id.

Identificador
kit_create_broadcast

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
subjectstringSíSubject line of the email.
contentstringSíBody of the email as HTML. On a Classic template, the template adds its design around this body.
preview_textstringNoPreview text shown after the subject in the inbox.
descriptionstringNoInternal description of the broadcast, not shown to the subscribers.
send_atstringNoWhen 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_addressstringNoSending address of the account to send from. The default sending address of the account when omitted.
email_template_idintegerNoID 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.
publicbooleanNotrue also publishes the broadcast on the web, in the newsletter feed of the Creator Profile and landing pages.
subscriber_filterarrayNoWho receives the broadcast: one object with exactly one of all, any or none. Omit it to send to every subscriber.

Conexiones posibles

Tu cliente conecta su cuenta de Kit una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/kit, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/kit_create_broadcast. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Kit

Ver las 13 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.