Peach
  1. messaging
Peach
  • messaging
    • Send a pre-approved template message
      POST
    • Poll template message status
      GET
    • Launch a broadcast
      POST
    • Poll broadcast status
      GET
    • Poll template messages status
      GET
    • Connect to AI Agent
      POST
  • whatsapp_templates
    • List all templates
      GET
    • Create a template
      POST
    • Update template
      PATCH
    • Archive template
      PATCH
    • Pause template
      PATCH
    • Submit template
      PATCH
  • conversations
    • Agent Assignment
      POST
    • Close Conversation
      POST
  • contacts
    • Create a contact on Peach
      POST
  • orders
    • Create an order
      POST
    • Find order by ID
      GET
    • Create a refund for an order
      POST
  • medias
    • List available medias
      GET
    • Add a media
      POST
    • Remove a media
      DELETE
  • webhooks
    • Order status webhooks
    • Flow execution status webhooks
    • Message delivery status webhooks
    • AI flow execution status webhooks
  1. messaging

Launch a broadcast

POST
https://app.trypeach.io/api/v1/events
messaging
Create and launch a WhatsApp broadcast to a list of contacts. The WhatsApp template to send should be approved for this API to work.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
event_type
enum<string> 
write-onlyrequired
Allowed value:
send_broadcast
broadcast
object 
write-onlyrequired
name
string 
write-onlyrequired
name
whats_app_template_id
string 
write-onlyrequired
liquid_values
object  | null 
write-onlyoptional
contacts
array [object {3}] 
write-onlyoptional
Mutually exclusive with audience_id
audience_id
string 
write-onlyoptional
Mutually exclusive with contacts
delivery_mode
enum<string> 
required
Allowed values:
instantgradual
deliveries
object 
optional
scheduled_launch_time
string <date-time>
optional
retries
object 
optional
reply_automation
object 
optional
phone_number
string 
optional
Examples
{
    "event_type": "send_broadcast",
    "broadcast": {
        "name": "Instant Broadcast via API",
        "whats_app_template_id": "wat_1234abcd",
        "liquid_values": {
            "invoice_amount": "₹1,000"
        },
        "audience_id": "lst_1234abcd",
        "delivery_mode": "instant"
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://app.trypeach.io/api/v1/events' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "event_type": "send_broadcast",
    "broadcast": {
        "name": "Instant Broadcast via API",
        "whats_app_template_id": "wat_1234abcd",
        "liquid_values": {
            "invoice_amount": "₹1,000"
        },
        "audience_id": "lst_1234abcd",
        "delivery_mode": "instant"
    }
}'

Responses

🟢200OK
application/json
Body
status
enum<string> 
read-onlyrequired
Allowed value:
success
event_id
string 
read-onlyrequired
Example
{
    "status": "success",
    "event_id": "string"
}
🟠422Unprocessable Entity
Modified at 2025-05-26 05:30:05
Previous
Poll template message status
Next
Poll broadcast status
Built with