Launch a broadcast

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

cURL

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

curl --location --request POST 'https://app.trypeach.io/api/v1/events' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--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

Example

{
    "status": "success",
    "event_id": "string"
}

🟠422Unprocessable Entity