Skip to content

Mail

mail_broadcast_get

Get one broadcast by id

Tool

mail_broadcast_get

Get one broadcast by id

Get one broadcast by id

Behavior

HTTP
GET /mail/broadcasts/:id

Arguments

NameTypeRequiredDescription
idstringNo description in the catalog.

Response

FieldTypeAlwaysDescription
idstring
fromstring
htmlstring
namestring
textstring
sentAtstring
statusstring
headersobject
replyToarray
subjectstring
queuedAtstring
createdAtstring
lastErrorstring
productIdstring
updatedAtstring
variablesstring
audienceIdstring
templateIdstring
recipientCountnumber

Try it

Get one broadcast by id.

When to use

Get one broadcast by id

Example

Ask your agent something like this:

Get one broadcast by id.

The agent will invoke mail_broadcast_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect