Tool
mail_broadcast_update
Edit a draft broadcast
Edit a draft broadcast
Behavior
- HTTP
PATCH /mail/broadcasts/:id
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | • | No description in the catalog. |
| from | string | — | No description in the catalog. |
| html | string | — | No description in the catalog. |
| name | string | — | No description in the catalog. |
| text | string | — | No description in the catalog. |
| headers | object | — | No description in the catalog. |
| replyTo | array | — | No description in the catalog. |
| subject | string | — | No description in the catalog. |
| template | object | — | No description in the catalog. |
| audienceId | string | — | No description in the catalog. |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| id | string | • | |
| from | string | • | |
| html | string | • | |
| name | string | • | |
| text | string | • | |
| sentAt | string | • | |
| status | string | • | |
| headers | object | • | |
| replyTo | array | • | |
| subject | string | • | |
| queuedAt | string | • | |
| createdAt | string | • | |
| lastError | string | • | |
| productId | string | • | |
| updatedAt | string | • | |
| variables | string | — | |
| audienceId | string | • | |
| templateId | string | • | |
| recipientCount | number | • |
Try it
Edit a draft broadcast.