Update broadcast with the Kit API

Updates a draft or scheduled broadcast. Send subject and content on every update, copied from List broadcasts when they do not change. Setting send_at schedules the sending, and null takes the broadcast back to draft.

Identifier
kit_update_broadcast

The request

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

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

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
idintegerYesID of the broadcast, from List broadcasts.
subjectstringYesSubject line of the email.
contentstringYesBody 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; null takes the broadcast back to draft.
email_addressstringNoSending address of the account to send from.
email_template_idintegerNoID of the email template, as the email_template id of a broadcast in List broadcasts. 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. Without it, every subscriber receives it.

Supported connections

Your customer connects their Kit account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/kit, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/kit_update_broadcast. It becomes your agent's tool definition with no conversion.

Other Kit tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.