Create broadcast with the Kit API
Creates a broadcast email as a draft, or schedules it when send_at is set. It goes to every subscriber, or only to the segments and tags in subscriber_filter. Returns the broadcast with its id.
- Identifier
- kit_create_broadcast
The request
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>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| subject | string | Yes | Subject line of the email. |
| content | string | Yes | Body of the email as HTML. On a Classic template, the template adds its design around this body. |
| preview_text | string | No | Preview text shown after the subject in the inbox. |
| description | string | No | Internal description of the broadcast, not shown to the subscribers. |
| send_at | string | No | When 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_address | string | No | Sending address of the account to send from. The default sending address of the account when omitted. |
| email_template_id | integer | No | ID 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. |
| public | boolean | No | true also publishes the broadcast on the web, in the newsletter feed of the Creator Profile and landing pages. |
| subscriber_filter | array | No | Who receives the broadcast: one object with exactly one of all, any or none. Omit it to send to every subscriber. |
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_create_broadcast. It becomes your agent's tool definition with no conversion.
Other Kit tools
- List subscribersGETLists the subscribers with their id, email, first name, state and custom fields, only the active ones by default. Look one up by email_address. The response has subscribers and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Create subscriberPOSTCreates an active subscriber. When the email address already belongs to a subscriber, it updates the first name of that subscriber instead. It adds no tag: use Apply tag next.
- Update subscriberPUTUpdates the email address, first name or custom fields of a subscriber. A custom field key that does not exist in the account makes the request fail.
- List tagsGETLists the tags with their id, name and creation date. The response has tags and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Create tagPOSTCreates a tag and returns it with its id. When a tag with the same name exists, ignoring case, it returns that tag instead of a duplicate.
- Apply tagPOSTApplies a tag to an existing subscriber, found by email address. Automations of the account that start with this tag run for the subscriber. Create the subscriber first with Create subscriber.
- List formsGETLists the forms and landing pages with their id, name, type and embed URL, only the active ones by default. The response has forms and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- List segmentsGETLists the segments with their id and name. Segments are built in the Kit app, and their ids target a broadcast in subscriber_filter. The response has segments and pagination; while has_next_page is true, pass pagination.end_cursor as after.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
