Poll template message status

GET

https://app.trypeach.io/api/v1/events/{{event_id}}

Poll the status of the event used to send a template message to a contact.

The field at the $.result.status JSONPath corresponds to the WhatsApp message status of the template message.

Request

Authorization

Add parameter in header

Authorization

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://app.trypeach.io/api/v1/events/{{event_id}}' \
--header 'Authorization: <api-key>'

Responses

🟢200Success

application/json

Body

Examples

Successful Template Message creationFailed Broadcast

{
    "id": "evt_1234abcd",
    "status": "processed",
    "result": {
        "type": "template_message",
        "id": "cmsg_1234abcd",
        "failure_message": null,
        "liquid_values": {
            "invoice_amount": "₹1000.00"
        },
        "publish_status": "published",
        "status": "sent",
        "created_at": "2025-05-19T10:00:00Z",
        "updated_at": "2025-05-19T10:00:00Z",
        "whats_app_template": {
            "id": "wat_1234abcd",
            "template_name": "Test Template"
        },
        "contact": {
            "name": "John Doe",
            "email": "johndoe@example.com",
            "phone_number": "+919988776655"
        }
    }
}

Modified at 2025-05-20 04:44:52

Send a pre-approved template message

Launch a broadcast