Components

Header Component

The Header Component is an optional component used at the beginning of a WhatsApp template message.

It helps businesses highlight important information or display media content before the main message body.

A Header can contain Text, Image, Video, GIF, Document, or Location content.

1. Image Header

{
    "type": "header",
    "parameters": [
        {
            "type": "image",
            "image": {
                "link": "https://example.com/product-image.jpg"
            }
        }
    ]
}

2. Video Header

{
    "type": "header",
    "parameters": [
        {
            "type": "video",
            "video": {
                "link": "https://example.com/product-demo.mp4"
            }
        }
    ]
}

3. Document Header

{
    "type": "header",
    "parameters": [
        {
            "type": "document",
            "document": {
                "link": "https://example.com/invoice.pdf",
                "filename": "Invoice_12345.pdf"
            }
        }
    ]
}

4. GIF Header

{
    "type": "header",
    "parameters": [
        {
            "type": "gif",
            "gif": {
                "link": "https://example.com/product-demo.gif"
            }
        }
     ]
 }

5. Location Header

{
    "type": "location",
    "location": {
        "latitude": "<LATITUDE>",
        "longitude": "<LONGITUDE>",
        "name": "<LOCATION_NAME>",
        "address": "<LOCATION_ADDRESS>"
     }
}

Body Component

The Body component contains the main message content of a WhatsApp template. It is the only mandatory component and must be included in every template.

The Body supports both static text and dynamic variables. Static text displays the same message to every customer, while dynamic variables allow the message to be personalized with customer-specific information.

Static Body

A static body contains only fixed text. Since there are no variables in the template, no parameters are required when sending the message.

{
    "type": "body",
    "parameters": []
}

Dynamic Body

A dynamic body contains one or more variables (for example, {{1}}, {{2}}, {{3}}) that are replaced with actual values when the message is sent.

{
    "type": "body",
    "parameters": [
        {
            "type": "text",
            "text": "<VARIABLE VALUE 1>"
        },
        {
            "type": "text",
            "text": "<VARIABLE VALUE 2>"
        },
        {
            "type": "text",
            "text": "<VARIABLE VALUE 3>"
        }
    ]
}

Button Components

The Buttons component adds interactive actions to a WhatsApp template, allowing customers to respond or perform an action directly from the message.

1. Call-to-Action (CTA) Button

A Call-to-Action (CTA) button allows customers to perform an action such as opening a website or making a phone call.

Website Button

A Website button opens a URL when the customer taps the button. Dynamic URLs can include variables.

{
    "type": "button",
    "sub_type": "url",
    "index": "0",
    "parameters": [
        {
            "type": "text",
            "text": "ORD12345"
        }
    ]
}

Example:
Template URL: https://example.com/track/{{1}}
Final URL: https://example.com/track/ORD12345

Copy Code Button

A Copy Code button allows customers to copy a predefined or dynamic code, such as a coupon or promotional code, directly from the message.

{
    "type": "button",
    "sub_type": "copy_code",
    "index": "0",
    "parameters": [
        {
            "type": "coupon_code",
            "coupon_code": "SAVE20"
        }
    ]
}

Voice call Button

{
    "type": "button",
    "sub_type" : "voice_call",
    "parameters": [
          {
            "type": "ttl_minutes",
            "ttl_minutes": 100
          },
          {
            "type": "payload",
            "payload": "payload data"
          }
    ]
}

Marketing Template components

Coupon Code

{
    "type": "button",
    "sub_type": "COPY_CODE",
    "index": 1,
    "parameters": [
        {
            "type": "coupon_code",
            "coupon_code": "25OFF"
        }
    ]
}

Limited-Time Offer

{
    "type": "limited_time_offer",
    "parameters": [
        {
            "type": "limited_time_offer",
            "limited_time_offer": {
                "expiration_time_ms": <EXPIRATION_TIME_MS>
            }
        }
    ]
}

Media Card Carousal

{
   "type": "carousel",
   "cards": [
        {
            "card_index": 0,
            "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "image",
                            "image": {
                                "link": "<IMAGE_URL>"
                            }
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "0",
                    "parameters": [
                        {
                            "type": "payload",
                            "payload": "more-aloes"
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "1",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "blue-elf"
                        }
                    ]
                }
            ]
        },
        {
            "card_index": 1,
            "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "image",
                            "image": {
                                "link": "<IMAGE_URL>"
                            }
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "0",
                    "parameters": [
                        {
                            "type": "payload",
                            "payload": "more-crassulas"
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "1",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "buddhas-temple"
                        }
                    ]
                }
            ]
        },
        {
            "card_index": 2,
            "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "image",
                            "image": {
                                "link": "<IMAGE_URL>"
                            }
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "0",
                    "parameters": [
                        {
                            "type": "payload",
                            "payload": "more-echeverias"
                        }
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "1",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "black-prince"
                        }
                    ]
                }
            ]
        }
    ]
}

Catalogs Template Components

Catalog

{
    "type": "button",
    "sub_type": "CATALOG",
    "index": 0,
    "parameters": [
        {
            "type": "action",
            "action": {
                "thumbnail_product_retailer_id": "<ID>"
            }
        }
    ]
}

Multi Product catalog

{
    "type": "button",
    "sub_type": "mpm",
    "index": 0,
    "parameters": [
        {
            "type": "action",
            "action": {
                "thumbnail_product_retailer_id": "2tx89l7rgc",
                "sections": [
                    {
                        "title": "Popular Bundles",
                        "product_items": [
                            {
                                "product_retailer_id": "g8c54efieg"
                            },
                            {
                                "product_retailer_id": "fmfsj2759e"
                            }
                        ]
                    },
                    {
                        "title": "Premium Packages",
                        "product_items": [
                            {
                                "product_retailer_id": "2tx89l7rgc"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

Single Product catalog

{
    "type": "header",
    "parameters": [
      {
        "type": "product",
        "product": {
          "product_retailer_id": "fmfsj2759e",
          "catalog_id": "1246197399818456"
        }
      }
    ]
}

Product Carousel Catalog

{
   "type": "carousel",
   "cards": [
      {
        "card_index": 0,
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "product",
                "product": {
                  "product_retailer_id": "2tx89l7rgc",
                  "catalog_id": "1246197399818456"
                }
              }
            ]
          }
        ]
      },
      {
        "card_index": 1,
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "product",
                "product": {
                  "product_retailer_id": "fmfsj2759e",
                  "catalog_id": "1246197399818456"
                }
              }
            ]
          }
        ]
      }
   ]
}

Payments Template Components

Order Details

{
    "type": "button",
    "sub_type": "order_details",
    "index": 0,
    "parameters": [
        {
            "type": "action",
            "action": {
                "order_details": {
                    "currency": "INR",
                    "order": {
                        "discount": {
                            "offset": 100,
                            "value": 250
                        },
                        "items": [
                            {
                                "amount": {
                                    "offset": 100,
                                    "value": 400
                                },
                                "name": "<ORDER_ITEM_NAME>",
                                "quantity": 1,
                                "retailer_id": "<ORDER_ITEM_RETAILER_ID>",
                                "country_of_origin": "<ORIGIN_COUNTRY>",
                                "importer_name": "<IMPORTER_NAME>",
                                "importer_address": {
                                    "address_line1": "<IMPORTER_ADDRESS>",
                                    "city": "<CITY>",
                                    "country_code": "<COUNTRY>",
                                    "postal_code": "<ZIP_CODE>"
                                }
                            }
                        ],
                        "shipping": {
                            "offset": 100,
                            "value": 0
                        },
                        "status": "pending",
                        "subtotal": {
                            "offset": 100,
                            "value": 400
                        },
                        "tax": {
                            "offset": 100,
                            "value": 500
                        }
                    },
                    "payment_settings": [
                        {
                            "type": "upi_intent_link",
                            "upi_intent_link": {
                                "link": "<UPI_LINK>"
                            }
                        }
                    ],
                    "payment_configuration": "unique_payment_config_id",
                    "payment_type": "upi",
                    "reference_id": "reference_id_value",
                    "total_amount": {
                        "offset": 100,
                        "value": 650
                    },
                    "type": "digital-goods"
                }
            }
        }
    ]
    }

Order Status

{
    "type": "order_status",
    "parameters": [
        {
            "type": "order_status",
            "order_status": {
                "reference_id": "refid123",
                "order": {
                    "status": "completed",
                    "description": "optional"
                }
            }
        }
    ]
}

Flow template Component

{
    "type": "button",
    "sub_type": "flow",
    "index": "0",
    "parameters": [
        {
            "type": "action",
            "action": {
                "flow_token": "FLOW_TOKEN",
                "flow_action_data": {}
            }
        }
    ]
}

Header Component#

1. Image Header#

2. Video Header#

3. Document Header#

4. GIF Header#

5. Location Header#

Body Component#

Static Body#

Dynamic Body#

Button Components#

1. Call-to-Action (CTA) Button#

Marketing Template components#

Catalogs Template Components#

Payments Template Components#

Flow template Component#