Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Streams Service

template_send - Whatsapp

Trigger a preconfigured event template for one or more recipients. Identify the template with event and pass each recipient's values in template_variables.

Modes — pick one:

  • Batch: set top-level sender and event; omit them on each recipient.
  • Mixed: omit the top-level values and set sender and event on every recipient.

Returns a batch task_id plus per-message identifiers; partial failures are reported inline.

Authentication: stream token in the Authorization header (see Authentication in the API Overview).

post/streams/event_send

Request body

senderstring

Top-level sender (batch mode).

eventstring

Top-level event/template name (batch mode).

Example request

{
  "sender": "CommPeak",
  "event": "verification_code",
  "recipients": [
    {
      "internal_id": "1001",
      "sender": "CommPeak",
      "recipient_phone": "447700900123",
      "template_variables": {
        "code": "4821"
      },
      "event": "verification_code"
    }
  ]
}

Response

The batch was accepted for delivery.

statusboolean

true when the batch was accepted. Individual messages may still carry an error.

task_idstring

Identifier for the accepted batch (processed asynchronously).

Example response

{
  "status": true,
  "task_id": "ca550f7e-9eb5-45b3-9830-e82b407ede02",
  "messages": [
    {
      "internal_id": "1001",
      "message_uuid": "a61e5bfe-c82b-448a-815b-32de8bf22089",
      "conversation_uuid": "e2a489db-bb8a-4f51-9692-726153599c57",
      "error": "0x31",
      "details": "reached daily limit"
    }
  ]
}