Skip to content

Mail

mail_broadcast_update

Edit a draft broadcast

Tool

mail_broadcast_update

Edit a draft broadcast

Edit a draft broadcast

Behavior

HTTP
PATCH /mail/broadcasts/:id

Arguments

NameTypeRequiredDescription
idstringNo description in the catalog.
fromstringNo description in the catalog.
htmlstringNo description in the catalog.
namestringNo description in the catalog.
textstringNo description in the catalog.
headersobjectNo description in the catalog.
replyToarrayNo description in the catalog.
subjectstringNo description in the catalog.
templateobjectNo description in the catalog.
audienceIdstringNo 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

Edit a draft broadcast.

When to use

Edit a draft broadcast

Example

Ask your agent something like this:

Edit a draft broadcast.

The agent will invoke mail_broadcast_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect