mail_broadcast_get

Tool

Get one broadcast by id

Name	Type	Required	Description
id	string	•	Broadcast id

Field	Type	Always	Description
id	string	•	Broadcast id
from	string	•	Sender the messages are sent as
html	string	•	Inline HTML body; null when a template supplies it
name	string	•	Internal label — never shown to recipients
text	string	•	Inline plain-text body; null when a template supplies it
sentAt	string	•	When the last message left; null until sending finishes
status	string	•	Lifecycle state: draft (editable), queued (fanned out, sending), sent, failed, canceled
headers	object	•	Custom MIME headers added to every message
replyTo	array	•	Reply-To addresses; empty when replies go to `from`
subject	string	•	Subject line for inline content; null when a template supplies it
queuedAt	string	•	When the broadcast was queued; null while it is a draft
createdAt	string	•	When the broadcast was created
lastError	string	•	Why the broadcast failed; null unless status is failed
productId	string	•	Product the broadcast belongs to
updatedAt	string	•	When the broadcast was last modified
variables	object	•	Values passed to the template variables; {} for inline content
audienceId	string	•	Audience whose contacts this broadcast is sent to
templateId	string	•	Template rendered for every recipient; null for inline content
recipientCount	integer	•	Contacts the broadcast fanned out to; 0 while it is still a draft

Get one broadcast by id.

When to use

Get one broadcast by id

Ask your agent something like this:

Get one broadcast by id.

The agent will invoke mail_broadcast_get with these arguments:

{
  "id": "<id>"
}