send template with parameteres | Messenger Mate

Endpoint

POST https://business.me-mate.net/whatsappbusiness/send-templated-message

Required header

Content-Type: application/json

How it works

Submit a JSON payload describing the recipient, sender, and template configuration. The API sends the specified approved WhatsApp template using the provided template name, language, and component data. The template.components array controls how dynamic content is injected into headers, body text, buttons, and carousel cards.

Request body fields

api_key: Your API key used to authorize the request.
sender: The configured WhatsApp-enabled sender number or identifier used to send the template.
campaign_id: Optional campaign identifier for tracking or internal grouping.
messaging_product: Messaging product value. Typically set to whatsapp.
recipient_type: Recipient category. Commonly individual for one-to-one delivery.
to: Recipient phone number in the required format.
type: Message type. For template messages, use template.
template.name: The approved template name to send.
template.language.code: Language code for the approved template variation, such as en.
template.components: Array of template components used to populate dynamic values and interactive content.

Supported template component patterns

template.components supports the following common structures:

1. Header component

Use a HEADER component when the template includes a header variable. NOTE A header supports a single parameter.

Text header:

1 {
2   "type": "HEADER",
3   "parameters": [
4     {
5       "type": "text",
6       "text": "variable value"
7     }
8   ]
9 }

Media header:

1 {
2   "type": "HEADER",
3   "parameters": [
4     {
5       "type": "IMAGE",
6       "image": {
7         "link": "https://example.com/image.jpg"
8       }
9     }
10   ]
11 }

The media parameter type can be IMAGE, VIDEO, or DOCUMENT, depending on the approved template format.

2. Body component

Use a BODY component to pass dynamic text values for body variables.

1 {
2   "type": "BODY",
3   "parameters": [
4     {
5       "type": "text",
6       "text": "variable value"
7     },
8     {
9       "type": "text",
10       "text": "variable value"
11     }
12   ]
13 }

Add parameters in the same order as the variables defined in the approved template.

3. Button components

Use button components when the template includes interactive buttons. The index should increase according to the button order in the approved template, starting from the first button (count all button like QUICK_REPLY, URL,COPY_CODE etc ).

URL button example:

1 {
2   "type": "BUTTON",
3   "sub_type": "URL",
4   "index": "0",
5   "parameters": [
6     {
7       "type": "text",
8       "text": "variable value"
9     }
10   ]
11 }

Copy code button example:

1 {
2   "type": "BUTTON",
3   "sub_type": "COPY_CODE",
4   "index": "2",
5   "parameters": [
6     {
7       "type": "coupon_code",
8       "coupon_code": "SAVE20"
9     }
10   ]
11 }

Depending on the approved template, button components may also support quick reply or call-oriented button patterns. Always match the sub_type, parameter type, and index to the template definition configured in WhatsApp.

4. Carousel templates

For carousel templates, use a CAROUSEL component and provide cards. Each card should include its card_index and the components required for that card, such as a header image and body or button parameters.

1 {
2   "type": "CAROUSEL",
3   "cards": [
4     {
5       "card_index": 0,
6       "components": [
7         {
8           "type": "HEADER",
9           "parameters": [
10             {
11               "type": "IMAGE",
12               "image": {
13                 "link": "https://example.com/card-1.jpg"
14               }
15             }
16           ]
17         },
18         {
19           "type": "BODY",
20           "parameters": [
21             {
22               "type": "text",
23               "text": "Card one title"
24             }
25           ]
26         }
27       ]
28     },
29     {
30       "card_index": 1,
31       "components": [
32         {
33           "type": "HEADER",
34           "parameters": [
35             {
36               "type": "IMAGE",
37               "image": {
38                 "link": "https://example.com/card-2.jpg"
39               }
40             }
41           ]
42         }
43       ]
44     }
45   ]
46 }

Example request payload

1 {
2   "api_key": "{{api_key}}",
3   "sender": "{{sender_phone}}",
4   "campaign_id": "campaign_001",
5   "messaging_product": "whatsapp",
6   "recipient_type": "individual",
7   "to": "{{recipient_phone}}",
8   "type": "template",
9   "template": {
10     "name": "order_update",
11     "language": {
12       "code": "en"
13     },
14     "components": [
15       {
16         "type": "HEADER",
17         "parameters": [
18           {
19             "type": "text",
20             "text": "variable value"
21           }
22         ]
23       },
24       {
25         "type": "BODY",
26         "parameters": [
27           {
28             "type": "text",
29             "text": "variable value"
30           },
31           {
32             "type": "text",
33             "text": "variable value"
34           }
35         ]
36       },
37       {
38         "type": "BUTTON",
39         "sub_type": "URL",
40         "index": "0",
41         "parameters": [
42           {
43             "type": "text",
44             "text": "variable value"
45           }
46         ]
47       }
48     ]
49   }
50 }

Implementation notes

Make sure the template name, language, component types, button definitions, and parameter ordering exactly match the approved WhatsApp template. Header components accept only one parameter. For button and carousel payloads, preserve the expected sequence and indexes so the API can map the data correctly.

Sends a WhatsApp template message through the MessengerMate Business API. Use this endpoint to deliver approved template messages to a single recipient, including support for standard template parameters, media headers, interactive buttons, and carousel cards. **Endpoint** `POST https://business.me-mate.net/whatsappbusiness/send-templated-message` **Required header** `Content-Type: application/json` **How it works** Submit a JSON payload describing the recipient, sender, and template configuration. The API sends the specified approved WhatsApp template using the provided template name, language, and component data. The `template.components` array controls how dynamic content is injected into headers, body text, buttons, and carousel cards. **Request body fields** - `api_key`: Your API key used to authorize the request. - `sender`: The configured WhatsApp-enabled sender number or identifier used to send the template. - `campaign_id`: Optional campaign identifier for tracking or internal grouping. - `messaging_product`: Messaging product value. Typically set to `whatsapp`. - `recipient_type`: Recipient category. Commonly `individual` for one-to-one delivery. - `to`: Recipient phone number in the required format. - `type`: Message type. For template messages, use `template`. - `template.name`: The approved template name to send. - `template.language.code`: Language code for the approved template variation, such as `en`. - `template.components`: Array of template components used to populate dynamic values and interactive content. **Supported template component patterns** `template.components` supports the following common structures: **1\. Header component** Use a `HEADER` component when the template includes a header variable. NOTE A header supports a single parameter. Text header: ``` json { "type": "HEADER", "parameters": [ { "type": "text", "text": "variable value" } ] } ``` Media header: ``` json { "type": "HEADER", "parameters": [ { "type": "IMAGE", "image": { "link": "https://example.com/image.jpg" } } ] } ``` The media parameter type can be `IMAGE`, `VIDEO`, or `DOCUMENT`, depending on the approved template format. **2\. Body component** Use a `BODY` component to pass dynamic text values for body variables. ``` json { "type": "BODY", "parameters": [ { "type": "text", "text": "variable value" }, { "type": "text", "text": "variable value" } ] } ``` Add parameters in the same order as the variables defined in the approved template. **3\. Button components** **Use button components when the template includes interactive buttons. The** **`index`** **should increase according to the button order in the approved template, starting from the first button (count all button like QUICK_REPLY, URL,COPY_CODE etc ).** URL button example: ``` json { "type": "BUTTON", "sub_type": "URL", "index": "0", "parameters": [ { "type": "text", "text": "variable value" } ] } ``` Copy code button example: ``` json { "type": "BUTTON", "sub_type": "COPY_CODE", "index": "2", "parameters": [ { "type": "coupon_code", "coupon_code": "SAVE20" } ] } ``` Depending on the approved template, button components may also support quick reply or call-oriented button patterns. Always match the `sub_type`, parameter type, and index to the template definition configured in WhatsApp. **4\. Carousel templates** For carousel templates, use a `CAROUSEL` component and provide `cards`. Each card should include its `card_index` and the components required for that card, such as a header image and body or button parameters. ``` json { "type": "CAROUSEL", "cards": [ { "card_index": 0, "components": [ { "type": "HEADER", "parameters": [ { "type": "IMAGE", "image": { "link": "https://example.com/card-1.jpg" } } ] }, { "type": "BODY", "parameters": [ { "type": "text", "text": "Card one title" } ] } ] }, { "card_index": 1, "components": [ { "type": "HEADER", "parameters": [ { "type": "IMAGE", "image": { "link": "https://example.com/card-2.jpg" } } ] } ] } ] } ``` **Example request payload** ``` json { "api_key": "{{api_key}}", "sender": "{{sender_phone}}", "campaign_id": "campaign_001", "messaging_product": "whatsapp", "recipient_type": "individual", "to": "{{recipient_phone}}", "type": "template", "template": { "name": "order_update", "language": { "code": "en" }, "components": [ { "type": "HEADER", "parameters": [ { "type": "text", "text": "variable value" } ] }, { "type": "BODY", "parameters": [ { "type": "text", "text": "variable value" }, { "type": "text", "text": "variable value" } ] }, { "type": "BUTTON", "sub_type": "URL", "index": "0", "parameters": [ { "type": "text", "text": "variable value" } ] } ] } } ``` **Implementation notes** Make sure the template name, language, component types, button definitions, and parameter ordering exactly match the approved WhatsApp template. Header components accept only one parameter. For button and carousel payloads, preserve the expected sequence and indexes so the API can map the data correctly.

Request

This endpoint expects an object.

tostringRequired

typestringRequired

senderstringRequired

api_keystringRequired

templateobjectRequired

campaign_idstringRequired

recipient_typestringRequired

messaging_productstringRequired

Response