Actions17
- AI Agent Actions
- Broadcast Actions
- Contact Actions
- Conversation Actions
- Media Actions
- Message Actions
Broadcast → Launch
AI-generatedSummary
Launch a WhatsApp template broadcast campaign through the Peach API by posting a send_broadcast event to /api/v1/events. Target an audience list, a manual contact list, or both.
Inputs
- Name (required) — Name of the broadcast campaign.
- Template ID (required) — ID of the WhatsApp template to send.
- Delivery Mode (required) — Instant or Gradual delivery of the messages. Defaults to Instant.
- Audience ID — ID of an existing audience list to target.
- Contacts — JSON array of contacts to target manually. Defaults to [].
- Liquid Values — JSON object of global liquid values for template personalization. Defaults to {}.
- Additional Fields — Optional collection: AI Agent ID (sent as reply_automation.app_id to handle replies), Business Phone Number (sender), Scheduled Launch Time, Skip Liquid Values Validation, Skip Phone Validation.
- Request Options — Node settings for batching (items per batch, interval), ignoring SSL issues, proxy, and timeout (default 10000 ms).
Output shape
The JSON response from the Peach API for the created launch event, one result per input item.
The source doesn't define the response fields. The operation's own description says the event ID can be passed to the Broadcast 'Get Event Status' operation to check progress. Authentication uses the peachApi credential against https://app.trypeach.ai.
Examples
Example 1: Send a promo template immediately to an existing audience
Name='Spring Sale', Template ID=, Delivery Mode=Instant, Audience ID=
Example 2: Schedule a personalized broadcast to a manual contact list
Delivery Mode=Gradual, Contacts=JSON array of contacts, Liquid Values={"offer":"20%"}, Additional Fields: Scheduled Launch Time and Business Phone Number.