Skip to content

mail_broadcast_create

Create a draft broadcast to an audience.

Tool

mail_broadcast_create

Create a draft broadcast to an audience.

Create a draft broadcast — inline content or a template reference — targeting an audience. It is created as a draft; queue it separately to send.

Arguments

Name
Type
Required
Description
name
string
•
Broadcast name (1–200 chars).
audienceId
uuid
•
Audience to send to.
from
string
•
Sender address (verified domain).
subject
string
—
Subject line.
html
string
—
HTML body.
template
object
—
Template reference: { id, variables }.
text
string
—
Plain-text email body.
headers
object
—
Custom email headers as a map of string values.default: {}
replyTo
array
—
Reply-To addresses as an array of strings.default: []

Try it

Draft a broadcast called July Update to my newsletter audience from news@example.com.

When to use

Create a draft broadcast — inline content or a template reference — targeting an audience. It is created as a draft; queue it separately to send.

Example

Ask your agent something like this:

Draft a broadcast called July Update to my newsletter audience from news@example.com.

The agent will invoke mail_broadcast_create with these arguments:

{
  "name": "July Update",
  "audienceId": "aud-uuid",
  "from": "News <news@example.com>",
  "subject": "What shipped in July",
  "html": "<p>…</p>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select