Actions17
- AI Agent Actions
- Broadcast Actions
- Contact Actions
- Conversation Actions
- Media Actions
- Message Actions
Broadcast → Cancel
AI-generatedSummary
Cancels an active Peach broadcast by ID by sending a PATCH request to the Peach WhatsApp Platform API.
Inputs
- Broadcast ID (required) — Unique ID of the broadcast to cancel. It is inserted into the request URL (/api/v1/broadcasts/{id}/cancel).
- Request Options — Optional node settings for the HTTP request: batching (items per batch, interval in ms), ignore SSL certificate issues, proxy URL, and timeout in ms (default 10000).
Output shape
The parsed JSON response from the Peach API for the cancel request, returned as output item(s). No request body is sent.
The source does not define the response schema. The node uses declarative routing, so the response is passed through as returned by the API, and API errors fail the node. Authentication uses the required peachApi credential against https://app.trypeach.ai.
Examples
Example 1: Stop a running campaign when an alert fires in another system.
Resource: Broadcast, Operation: Cancel, Broadcast ID set to an expression such as {{$json.broadcastId}}.
Example 2: Cancel several broadcasts passed in as multiple input items without hitting rate limits.
Broadcast ID = {{$json.id}}; Request Options > Batching with Items per Batch 10 and Batch Interval 1000 ms.