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

Launch Instant Broadcast to a pre-configured ListLaunch Gradual Broadcast to a pre-configured ListSchedule an Instant Broadcast with custom retries configurationSchedule a Gradual Broadcast with custom deliveries configurationLaunch Instant Broadcast to a list of ContactsLaunch Gradual Broadcast to a list of ContactsLaunch Instant Broadcast with AI AgentLaunch Gradual Broadcast with an AI Agent

{
    "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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Poll template message status

Poll broadcast status