Written review request via WhatsApp API

The scenario sends the client a personalized WhatsApp template after a completed interaction, asking them to leave a written review or testimonial.

Try the demo View code example

Use case overview

The scenario sends the client a personalized WhatsApp template after a completed interaction, asking them to leave a written review or testimonial. The message includes the client name, product or service context, and a short review prompt. A static URL button opens the review form; the client can also reply with text in the opened session window.

Template example

Hello, {{1}}! Thank you for choosing {{2}}. {{3}} Please share your written review — it takes about a minute.

Leave review

{{1}}
customer name
{{2}}
product or service context (e.g. salon visit, online order, completed service)
{{3}}
review prompt or instruction (e.g. share your written review, takes 1 minute)
“Leave review”
button — fixed in the Meta template

WhatsApp Business API for text review request

When to use it

Use this scenario when a purchase, visit, or service is complete and the team needs a structured written review request on WhatsApp rather than a manual agent message or email-only follow-up. It fits local services and retail collecting testimonials after delivery, hospitality and clinics asking for service feedback, and agencies connecting review triggers from CRM, booking systems, or e-commerce workflows.

Higher written review response rates

The review request lands in WhatsApp with name, product or service context and review prompt as three body variables, so the testimonial ask sits in a channel the client already uses instead of an email form they never open.

Compliant first message after completion

The operations system fires an approved template when the interaction is eligible, so the review request reaches the client even when there is no open conversation and free-text replies are not allowed.

No manual review follow-up messages

The review trigger resolves the recipient phone and review fields, builds the template with three body variables and a static URL button, so staff do not retype service context or remember to send a review link.

Service context before they write

Customer name and product or service context appear in the message body, so the client knows exactly what experience they are reviewing before tapping the fixed Leave review button or replying in the session.

Delivery logged for follow-up analytics

Delivery result is written back to the CRM or operations system while review submission is tracked on the linked form or via inbound session replies, so review follow-up stays tied to the same interaction record.

Workflow

Trigger
The CRM or operations system fires a review trigger when the interaction is eligible.
event · triggered
Capture event
The system resolves the recipient phone number and review fields.
phone: "+…"
Build & send
A personalized template message is built with three body variables and a static URL button.
POST /sendTemplate
Delivered
The client receives the WhatsApp review request with product or service context.
delivered
Status tracked
Delivery result is logged; written review submission is tracked via the linked form or inbound session reply.
status: "read"

Technical implementation

Prerequisites

1MSG API Key · How to get API Key
WhatsApp Business account · How to Connect WABA
WhatsApp Template · How to Approve WABA Template
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_PRODUCTORSERVICENAME="___"         # {{2}} product or service name
TEST_NEXTSTEP="___"         # {{3}} next step

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_PRODUCTORSERVICENAME=$TEST_PRODUCTORSERVICENAME" \
            "TEST_NEXTSTEP=$TEST_NEXTSTEP"; 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}} product or service name → ${TEST_PRODUCTORSERVICENAME}
# {{3}} next step → ${TEST_NEXTSTEP}
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_PRODUCTORSERVICENAME}" },
        { "type": "text", "text": "${TEST_NEXTSTEP}" }
      ]
    }

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

Status	API response	Cause	Fix
200	Message was not sent: template is not defined	namespace, 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"}.
200	template 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.
200	Message was not sent: provide chatId, phone, bsuid, or username	No recipient the channel could resolve.	Pass exactly one recipient: phone (country code plus number, digits only), chatId (for example [email protected]) or bsuid.