Multi-Product Templates

If you are using On-Premise API, remember that it is being discontinued by Meta. No new signups will be allowed with this type of integration from May 15, 2024.

Numbers registered before this date will still be supported, but should start planning a change of hosting type as soon as possible.

Multi-Product Message templates can be used to open marketing conversations, meaning you can start a conversation using this template. They allow you to showcase up to 30 products from your ecommerce catalog, organized in up to 10 sections, in a single message.

Customers can browse products and sections within the message, view details for each product, add and remove products from their cart, and submit their cart to place an order. Orders are then sent to you via a webhook.

https://www.facebook.com/business/help/978451836847222www.facebook.com

Requirements

You must have inventory uploaded to Meta in an ecommerce catalog connected to your WhatsApp Business Account. See Products and Catalogs.

Limitations

• Customers must be using WhatsApp v2.22.24 or greater. Multi-Product Templates works for both Cloud and On-premise API.

• MPM templates cannot be forwarded to other customers.

Template Creation

Use the create template endpoint and assemble the Catalog Template components in the request:

As announced in November 2023, Meta is transitioning to a fully Cloud-hosted WhatsApp Business Platform and will stop supporting On-Premise API in October 2025.

Starting from On-Premise client v2.53, all new feature updates will be exclusively delivered to Cloud API. While the On-Premise API client will receive quarterly releases, they will focus solely on bug fixes and security patches. From May 15, 2024, 360dialog will not allow for new numbers to be onboarded with On-Premise API. We will continue supporting already registered On-Premise API throughout 2024, but we strongly recommend to start changing the hosting type of numbers to Cloud as soon as possible. Learn here how to integrate with Cloud API.

POST [base-url]/v1/configs/templates

The message template name field is limited to 512 characters. The message template content field is limited to 1024 characters.

Headers

Name	Type	Description
D360-API-KEY	string

Request Body

Name	Type	Description
name*	string
components*	array[objects]	Array of objects that describe the components that make up the template.
category*	string	Allowed values: MARKETING
language*	string	View list of supported languages here.

200: OK

{
  "name": "<NAME>",
  "category": "<CATEGORY>",
  "language": "<LANGUAGE>",
  "components": [<COMPONENTS>]
}

Parameters

Placeholder	Description	Sample Value
<CATEGORY>	Required. Template category. Set this to MARKETING.	MARKETING
<COMPONENTS>	Required. Array of objects that describe the components that make up the template. See Components below.	See Components below.
<LANGUAGE>	Required. Template language and locale code.	en_US
<NAME>	Required. Template name. Maximum 512 characters.	abandoned_cart

Components

The components value must be an array of objects that describes each component that makes up the template. MPM templates must have the following components:

• a single header component

• a single body component

• a single footer component (optional)

• a single MPM button component

[
  {
    "type": "HEADER",
    "format": "TEXT",
    "text": "<HEADER_TEXT>",
    
    /* Example required if header uses a variable */
    "example": {
      "header_text": [
        "<HEADER_EXAMPLE_TEXT>"
      ]
    }
  },
  {
    "type": "BODY",
    "text": "<BODY_TEXT>",

    /* Example required if body uses variables */
​​    "example": {
      "body_text": [
        [
          "<BODY_EXAMPLE_TEXT>"
        ]
      ]
    }
  },
  {
    "type": "FOOTER",
    "text": "<FOOTER_TEXT>"
  },
  {
    "type":"BUTTONS",
    "buttons": [
      {
        "type": "MPM",
        "text": "View items"
      }
    ]
  }
]

Properties

Placeholder	Description	Sample Value
<BODY_EXAMPLE_TEXT>	String or array of strings. Example body variable value(s).	10OFF
<BODY_TEXT>	Template body text. Supports multiple variables. If the string contains variables, you must include the example property and sample variable values. 1024 characters maximum.	Forget something, {{1}}?
<FOOTER_TEXT>	Template footer text. 60 characters maximum.	Lucky Shrub, 1 Hacker Way, Menlo Park, CA 94025
<HEADER_EXAMPLE_TEXT>	Example header variable value.	Pablo
<HEADER_TEXT>	Template header text. Supports 1 variable. If the string contains a variable, you must include the example property and a sample variable value. 60 characters maximum.	Looks like you left these items in your cart, still interested? Use code {{1}} to get 10% off!

Sample Request

{
  "name": "abandoned_cart",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Forget something, {{1}}?",
      "example": {
        "header_text": [
          "Pablo"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Looks like you left these items in your cart, still interested? Use code {{1}} to get 10% off!",
      "example": {
        "body_text": [
          [
            "10OFF"
          ]
        ]
      }
    },
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type": "MPM",
          "text": "View items"
        }
      ]
    }
  ]
}

Sending MPM Templates

Use the API to send an MPM template once it has been approved.

POST https://waba-v2.360dialog.io/messages

Request Body

Name	Type	Description
components	String	See Components
language	String	View list of supported languages here.

201: Created

{
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "12015553931",
            "wa_id": "12015553931"
        }
    ],
    "messages": [
        {
            "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI4Qzc5QkNGNTc5NTMyMDU5QzEA"
        }
    ]
}

Post Body

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<TO>",
  "type": "template",
  "template": {
    "name": "<NAME>",
    "language": {
      "code": "<CODE>"
    },
    "components": [

      /* Header component required if template uses a header variable, otherwise omit */
      {
        "type": "header",
        "parameters": [
          {
            "type": "text",
            "text": "<HEADER_TEXT>"
          }
        ]
      },

      /* Body component required if template uses a body variable, otherwise omit */
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "<BODY_TEXT>"
          }
        ]
      },

      /* MPM button component always required */
      {
        "type": "button",
        "sub_type": "mpm",
        "index": 0,
        "parameters": [
          {
            "type": "action",
            "action": {
              "thumbnail_product_retailer_id": "<THUMBNAIL_PRODUCT_RETAILER_ID>",
              "sections": [
                {
                  "title": "<TITLE>",
                  "product_items": [
                    {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                    },
                    ... // Additional item objects (up to 30)
                  ]
                },
                ... // Add section objects (up to 10)
              ]
            }
          }
        ]
      }
    ]
  }
}

Properties

Placeholder	Description	Sample Value
<BODY_TEXT>	Required if template uses variables. String or array of strings. Text to replace body variable(s) defined in the template.	10OFF
<CODE>	Template language and locale code.	en_US
<HEADER_TEXT>	Required if template uses a variable. Text to replace header variable defined in the template.	Pablo
<NAME>	Template name.	abandoned_cart
<PRODUCT_RETAILER_ID>	SKU number of the item you want to appear in the section. SKU numbers are labeled as Content ID in the Commerce Manager. Supports up to 30 products total, across all sections.	2lc20305pt
<THUMBNAIL_PRODUCT_RETAILER_ID>	Item SKU number. Labeled as Content ID in the Commerce Manager. The thumbnail of this item will be used as the template message's header image.	2lc20305pt
<TITLE>	Section title text. You can define up to 10 sections. Maximum 24 characters. Markdown is not supported.	Popular Bundles
<TO>	Customer phone number.	1650555123

Example Request

This example sends an approved template named "abandoned_cart" and injects a variable (the customer's first name) into the template header and a discount code into the template body. It also defines two sections ("Popular Bundles" and "Premium Packages") and identifies the products (a total of 3) that should be injected into those sections.

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "16505551234",
  "type": "template",
  "template": {
    "name": "abandoned_cart",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "text",
            "text": "Pablo"
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "10OFF"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "mpm",
        "index": 0,
        "parameters": [
          {
            "type": "action",
            "action": {
              "thumbnail_product_retailer_id": "2lc20305pt",
              "sections": [
                {
                  "title": "Popular Bundles",
                  "product_items": [
                    {
                      "product_retailer_id": "2lc20305pt"
                    },
                    {
                      "product_retailer_id": "nseiw1x3ch"
                    }
                  ]
                },
                {
                  "title": "Premium Packages",
                  "product_items": [
                    {
                      "product_retailer_id": "n6k6x0y7oe"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    ]
  }
}'

Webhooks

When a customer adds one or more products to their cart and submits an order, Meta will send you a webhook that describes the order.

Webhook Syntax

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<ENTRY.ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<NAME>"
                },
                "wa_id": "<WA_ID>"
              }
            ],
            "messages": [
              {
                "from": "<FROM>",
                "id": "<MESSAGES.ID>",
                "timestamp": "<TIMESTAMP>",
                "type": "order",
                "order": {
                  "catalog_id": "<CATALOG_ID>",
                  "product_items": [
                    {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>",
                      "quantity": <QUANTITY>,
                      "item_price": <ITEM_PRICE>,
                      "currency": "<CURRENCY>"
                    }
                  ]
                }
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Webhook Contents

Placeholder	Description	Sample Value
<CATALOG_ID>	Ecommerce product catalog ID.	1537566713439863
<CURRENCY>	Item currency.	USD
<DISPLAY_PHONE_NUMBER>	Business phone number display number.	15550051310
<ENTRY.ID>	WhatsApp Business Account ID.	102290129340398
<ITEM_PRICE>	Item price.	99.99
<MESSAGES.ID>	WhatsApp message ID.	wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBJDOEI3ODgxNzQzMjJBQTdEQTcA
<NAME>	Customer's name.	Pablo Morales
<PHONE_NUMBER_ID>	Business phone number ID.	106540352242922
<PRODUCT_RETAILER_ID>	The item SKU number. Labeled as Content ID in the Commerce Manager.	2lc20305pt
<QUANTITY>	Number of items ordered (for this particular item).	1
<TIMESTAMP>	UNIX timestamp indicating when we sent you the webhook.	1677522117
<WA_ID>	Customer's WhatsApp phone number.	16505551234

Sample Webhook

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "102290129340398",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "15550051310",
              "phone_number_id": "106540352242922"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Pablo Morales"
                },
                "wa_id": "16505551234"
              }
            ],
            "messages": [
              {
                "from": "16505551234",
                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTMxNzA1QzNENEI4ODY0OTY2MAA=",
                "timestamp": "1683223069",
                "type": "order",
                "order": {
                  "catalog_id": "1537566713439863",
                  "product_items": [
                    {
                      "product_retailer_id": "n6k6x0y7oe",
                      "quantity": 1,
                      "item_price": 99.99,
                      "currency": "USD"
                    }
                  ]
                }
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}