Create broadcast draft
createBroadcastDraftSave a send to audiences as a draft, without sending it. Nothing goes out and nothing counts against the plan. updateBroadcast changes it, sendBroadcastTest sends a test copy, and sendBroadcastDraft sends or schedules it. Takes the same fields as sendToAudience, but audienceIds may be left out until later. Each person gets their own copy, so nobody sees anybody else. Personalise with {{firstName}}, {{lastName}}, {{name}}, {{email}} and {{unsubscribeUrl}}, and give a fallback after a bar: {{firstName|there}}. A custom field of the contact is {{attributes.}} in the subject and an html or text body, such as {{attributes.plan|Free}}, and reads as its fallback, or nothing, when the contact has no such field. Every copy carries a one-click unsubscribe header, and a short unsubscribe line is added at the end of an html or text body that does not place {{unsubscribeUrl}} itself. A template gets the same values as props, for the props it declares.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"from": "<from>"
},
"name": "createBroadcastDraft"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| utm | No | Campaign tags added to the links, such as { source, medium, campaign }. | |
| from | Yes | ||
| html | No | ||
| tags | No | Up to 8 tags of your own, copied onto every copy beside broadcast_id. | |
| text | No | ||
| props | No | ||
| slots | No | Values for the template's slots, the parts its layout leaves for each send. | |
| abTest | No | An A/B test: 2 to 4 variants, each a subject or a body (html or text) that replaces the broadcast's own ({} keeps it), testPercent of the people (5 to 50, 20 unless set) split evenly between them, metric (opens or clicks) to pick the winner, and waitMinutes (30 to 4320, 240 unless set) to wait before picking it. Everybody else then gets the winning variant. A template broadcast can only vary the subject. | |
| replyTo | No | ||
| subject | No | ||
| segmentId | No | A saved segment id (seg_...) that narrows the audiences: only the contacts that match its conditions get a copy. listSegments shows them. | |
| templateId | No | ||
| trackOpens | No | ||
| audienceIds | No | ||
| trackClicks | No | ||
| templateVersion | No | ||
| excludeAudienceIds | No | Audiences whose members are left out, even when they are in one of audienceIds. |