Peach

Launch a Broadcast

Developing

POST

/events

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 {2}]

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

Example

{
  "event_type": "send_broadcast",
  "broadcast": {
    "name": "Broadcast Name",
    "whats_app_template_id": "wat_1234abcd",
    "liquid_values": {
      "invoice_amount": "₹1,000"
    },
    "contacts": [
      {
        "phone_number": "+919876543210",
        "name": "John",
        "invoice_amount": "₹101"
      },
      {
        "phone_number": "+917654321098",
        "name": "Jane"
      }
    ],
    "audience_id": "lst_1234abcd",
    "delivery_mode": "instant",
    "deliveries": {
      "delivery_schedule": {
        "start_date": "2023-10-01",
        "end_date": "2023-10-31"
      },
      "delivery_window": {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    },
    "scheduled_launch_time": "2023-10-01T12:00:00+05:30",
    "retries": {
      "retry_until": "2025-04-13",
      "retry_window": {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    },
    "reply_automation": {
      "ai_agent_id": "aiflw_1234abcd"
    },
    "phone_number": "+919988776655"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/events' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
  "event_type": "send_broadcast",
  "broadcast": {
    "name": "Broadcast Name",
    "whats_app_template_id": "wat_1234abcd",
    "liquid_values": {
      "invoice_amount": "₹1,000"
    },
    "contacts": [
      {
        "phone_number": "+919876543210",
        "name": "John",
        "invoice_amount": "₹101"
      },
      {
        "phone_number": "+917654321098",
        "name": "Jane"
      }
    ],
    "audience_id": "lst_1234abcd",
    "delivery_mode": "instant",
    "deliveries": {
      "delivery_schedule": {
        "start_date": "2023-10-01",
        "end_date": "2023-10-31"
      },
      "delivery_window": {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    },
    "scheduled_launch_time": "2023-10-01T12:00:00+05:30",
    "retries": {
      "retry_until": "2025-04-13",
      "retry_window": {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    },
    "reply_automation": {
      "ai_agent_id": "aiflw_1234abcd"
    },
    "phone_number": "+919988776655"
  }
}'

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-04-15 10:18:01

Send a pre-approved template message

Create a contact on Peach