Broadcast

The Broadcast (a.k.a. Bulk Sendout) endpoint allows you to send Messages or Templates to a large, pre-defined group of existing contacts in a single request.

It is designed for campaigns, announcements, and time-bound notifications across messaging channels.
Bulk Sendout is the recommended approach for 1:N messaging and should be used instead of individual message calls when targeting multiple recipients.

ENDPOINT | API Reference
POST https://api.chatwerk.de/inbox/channels/:channel_id/messages/template

Prerequisites

• Target contacts must already exist in the system
• If not, import them first using:
  POST /inbox/channels/:channel_id/gateways/:gateway_id/import-conversations

Supported Content Types

template - Sends a reusable template (including WhatsApp-submitted templates)

message- Sends a concrete message payload (text, image, media, etc.)

Targeting Recipients

Recipients are selected via filters, for example:

• Conversation labels (e.g. campaigns or inbound triggers)
• Conversation attributes (e.g. shoe_size = 42)

Targeting is defined in targeting.filter.

Time-To-Live (TTL)

Limit delivery time using:

"ttl_in_minutes": 60  

Messages not delivered within the TTL will be discarded. Useful for time-sensitive events.

Example: Template Sendout

{
  "type": "template",
  "targeting": {
    "filter": {
      "conversation.labels": { "contains": "targeted_label" }
    }
  },
  "template": {
    "id": "template00",
    "components": {
      "flight_number": { "type": "text", "text": "RKL 1234" },
      "date": { "type": "text", "text": "2025-01-01" },
      "name": {
        "type": "extractor",
        "text": "Default Name",
        "extractor": "conversation.name"
      }
    }
  },
  "ttl_in_minutes": 60
}

Example: Message Sendout

{
  "type": "message",
  "targeting": {
    "filter": {
      "conversation.labels": {
        "contains": "Weihnachtsgruesse - 2025"
      }
    }
  },
  "message": {
    "type": "text",
    "text": "*Vielen Dank für die Zusammenarbeit 💛*\n\n{{link 👉 Jetzt anmelden! | https://bit.ly}}",
    "data": {
      "header": {
        "type": "image",
        "media": { "id": "isTziFRZmijmNQmu" }
      }
    }
  },
  "ttl_in_minutes": 60
}