Skip to content

Mail

mail_broadcast_cancel

Cancel a draft or queued broadcast

Tool

mail_broadcast_cancel

Cancel a draft or queued broadcast

Cancel a draft or queued broadcast

Behavior

HTTP
POST /mail/broadcasts/:id/cancel

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

Cancel a draft or queued broadcast.

When to use

Cancel a draft or queued broadcast

Example

Ask your agent something like this:

Cancel a draft or queued broadcast.

The agent will invoke mail_broadcast_cancel with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect