💬 Shared WhatsApp Inbox on the new PlatformMore
1msg official logo

Promo campaign broadcast via WhatsApp API

The scenario sends a personalised WhatsApp template when marketing launches a visual campaign.

Use case overview

The scenario sends a personalised WhatsApp template when marketing launches a visual campaign. The message includes the contact's name, the campaign name, and a short creative hook. A static URL button opens the campaign landing page where the banner creative lives.

Template example

Hello, {{1}}! Our campaign "{{2}}" is now live. {{3}} Tap the button below to open the campaign page and explore the offer.

View campaign
  • {{1}}
    customer name
  • {{2}}
    campaign name
  • {{3}}
    creative hook or tagline for the campaign
  • “View campaign”
    button — fixed in the Meta template
WhatsApp Business API for promo banner broadcast

When to use it

Use this scenario when marketing ships a visual creative with a dedicated landing page and needs the full opted-in base to see the campaign name and tap through — not a plain discount line or a product list. It fits seasonal retail pushes, brand launch waves, and agencies running named creative campaigns for client brands on WhatsApp.

Campaign reach without an open chat
An approved MARKETING template reaches opted-in contacts outside the 24-hour window, so the broadcast does not depend on an existing conversation.
The creative lives on the landing page
The body names the campaign and a short hook while a static URL button opens the banner landing page — no image header variable is required in the API payload.
Personalisation at broadcast scale
Three body variables carry the contact name, campaign title, and creative tagline, so each message reads as a named campaign invite rather than a generic blast.
Less manual list work
CRM or automation loads the segment on launch day and the template goes out on that trigger, so marketing does not retype campaign copy for each contact.
Measurable campaign taps
Delivery results return to the sending system and button taps land on the campaign URL, so performance reports tie back to the same broadcast run.

Workflow

  1. Trigger

    Marketing schedules a campaign launch and defines the contact segment.

    event · triggered

  2. Capture event

    The system resolves each recipient phone and campaign personalisation fields.

    phone: "+…"

  3. Build & send

    A personalised campaign template is built with three body variables and a static URL button.

    POST /sendTemplate

  4. Delivered

    Each contact receives the WhatsApp campaign message.

    delivered

  5. Status tracked

    Delivery and button taps are logged for campaign performance reporting.

    status: "read"

WhatsApp Business API for promo banner broadcast

Technical implementation

Prerequisites

  1. 1MSG API Key · How to get API Key
  2. WhatsApp Business account · How to Connect WABA
  3. WhatsApp Template · How to Approve WABA Template
  4. Customer opt-in · How to Manage Customers Consent

Code examples

#!/usr/bin/env bash
set -euo pipefail

# === Configuration (replace "___" placeholders) ===

API_BASE_URL="https://api.1msg.io"        # production 1MSG API base URL
CHANNEL_ID="___"                           # channel ID from 1MSG dashboard
API_TOKEN="___"                            # channel JWT token (Bearer)

TEMPLATE_NAME="___"                        # approved template name
TEMPLATE_NAMESPACE="___"                   # template namespace (required — send fails without it)
TEMPLATE_LANGUAGE="___"                    # template language code, e.g. "en"



# === Test data ===
TEST_PHONE="___"                 # client phone in international format
TEST_CUSTOMERNAME="___"         # {{1}} customer name
TEST_TOPIC="___"         # {{2}} topic or subject
TEST_ADDITIONALINFO="___"         # {{3}} additional info

PHONE_NORM="$(printf '%s' "$TEST_PHONE" | tr -cd '0-9')"

for pair in "CHANNEL_ID=$CHANNEL_ID" "API_TOKEN=$API_TOKEN" \
            "TEMPLATE_NAME=$TEMPLATE_NAME" "TEMPLATE_NAMESPACE=$TEMPLATE_NAMESPACE" \
            "TEMPLATE_LANGUAGE=$TEMPLATE_LANGUAGE" "TEST_PHONE=$TEST_PHONE" \
            "TEST_CUSTOMERNAME=$TEST_CUSTOMERNAME" \
            "TEST_TOPIC=$TEST_TOPIC" \
            "TEST_ADDITIONALINFO=$TEST_ADDITIONALINFO"; do
    val="${pair#*=}"
    if [ -z "$val" ] || [ "$val" = "___" ]; then
        echo "Missing configuration value: ${pair%%=*}" >&2
        exit 1
    fi
done

if [ -z "$PHONE_NORM" ]; then
    echo "Error: phone number has no digits after normalization" >&2
    exit 1
fi

URL="${API_BASE_URL%/}/${CHANNEL_ID}/sendTemplate"

# params carries body ONLY. Button text is fixed in the Meta template — no button param.

# {{1}} customer name → ${TEST_CUSTOMERNAME}
# {{2}} topic or subject → ${TEST_TOPIC}
# {{3}} additional info → ${TEST_ADDITIONALINFO}
read -r -d '' PAYLOAD <<JSON || true
{
  "phone": "${PHONE_NORM}",
  "template": "${TEMPLATE_NAME}",
  "namespace": "${TEMPLATE_NAMESPACE}",
  "language": { "policy": "deterministic", "code": "${TEMPLATE_LANGUAGE}" },
  "params": [
    {
      "type": "body",
      "parameters": [
        { "type": "text", "text": "${TEST_CUSTOMERNAME}" },
        { "type": "text", "text": "${TEST_TOPIC}" },
        { "type": "text", "text": "${TEST_ADDITIONALINFO}" }
      ]
    }

  ]
}
JSON

RESPONSE="$(curl -s -w '\n%{http_code}' -X POST "$URL" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${API_TOKEN}" \
    -d "$PAYLOAD")"

HTTP_CODE="$(printf '%s' "$RESPONSE" | tail -n1)"
BODY="$(printf '%s' "$RESPONSE" | sed '$d')"

case "$BODY" in
    *'"sent":true'*) ok=1 ;;
    *) ok=0 ;;
esac

if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ] && [ "$ok" -eq 1 ]; then
    echo "Message sent to client."
    echo "API response: $BODY"
else
    echo "Send failed. HTTP status: $HTTP_CODE" >&2
    echo "$BODY" >&2
    exit 1
fi

Response and delivery status

HTTP 2xx and JSON "sent": true mean 1MSG accepted the message for sending — not that it already reached the customer's phone. Save the id field (looks like wamid.…) to correlate delivery callbacks.

200 OKResponse
{
  "sent": true,
  "message": "Sent to [email protected]",
  "description": "Message has been sent to the provider",
  "id": "wamid.HBgLMzgwNjM5..."
}
  • sent

    Accepted for sending — not yet on the customer's phone

  • id

    Store it; delivery callbacks and hookInfo are keyed on this

Delivery statuses and webhooks →

Common errors

StatusAPI responseCauseFix
200Message was not sent: template is not definednamespace, template or language is missing from the request body.Send all three. Take namespace and the exact template name from GET /templates; language is an object: {"policy": "deterministic", "code": "en"}.
200template name (…) does not exist in <language>The template is approved in a different language than the one requested.Use the exact language code the template was approved in (for example es_MX is not the same as es). Check it in GET /templates.
200Message was not sent: provide chatId, phone, bsuid, or usernameNo recipient the channel could resolve.Pass exactly one recipient: phone (country code plus number, digits only), chatId (for example [email protected]) or bsuid.

All error codes →

Common questions

Related

Build for WhatsApp in hours
without infrastructure hassle