Send Multi-Product Template Messages

POST Method

The Send Multi-Product Template Messages allows you to send multi-product template messages to WhatsApp users.

For more information on their uses and how to create them, see MPM templates.

MPM template messages must have:

  • A header component (only required if template uses a header variable).
  • A body component (only required if template uses a body variable).
  • A single MPM button component.

Prerequisites

  1. Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
    A prerequisite for using Kaleyra WhatsApp APIs is to have an active WhatsApp plan on kaleyra platform.
  2. To set up a WhatsApp account on kaleyra.io, see Manual Signup
    and Embedded Signup.
  3. An active WhatsApp for Business API plan that includes:
    • A WhatsApp business number.
    • An associated profile with the business number.
    • A WhatsApp verified and approved profile.
    • A WABA ID onboarded on Kaleyra WhatsApp API V2.
  1. Product Catalogue have to be uploaded in the WhatsApp Business Account (WABA).

Base URL

https://<api_domain>/v2/<SID>

API Domain and Value

api_domainValue
IN podapi.in.kaleyra.io
SG Podapi.kaleyra.io
EU Podapi.eu.kaleyra.io
NA podapi.na.kaleyra.ai

API request to send Multi-Product Template Messages

To send Multi-Product Template Messages, use the https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages endpoint with the following request method:

Request Format

The following is the request format to send Multi-Product Template Messages:

curl -X POST \
  https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages \
  -H 'Content-Type: <content_type>' \
  -H 'api-key: <api-key>' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "<messaging_product>",
        "recipient_type": "<recipient_type>",
        "to": "<to>",
        "type": "<type>",
        "template": {
            "name": "<template_name>",
            "language": {
                "code": "<language_code>"
            },
            "components": [              
                {
                    "type": "<type>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "text": "<header_text>"
                        }
                    ]
                },             
                {
                    "type": "<type>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "text": "<body_text>"
                        }
                    ]
                },            
                {
                    "type": "<type>",
                    "sub_type": "<sub_type>",
                    "index": <index>,
                    "parameters": [
                        {
                            "type": "<type>",
                            "action": {
                                "thumbnail_product_retailer_id": "<thumbnail_product_retailer_id>",
                                "sections": [
                                    {
                                        "title": "<title>",
                                        "product_items": [
                                            {
                                                "product_retailer_id": "<product_retailer_id>"
                                            },
											
                                        ]
                                    },
								
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

The following is the sample request format to send Multi-Product Template Messages:

curl -X POST \
  https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: application/json' \
  -H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "whatsapp",
        "recipient_type": "individual",
        "to": "+91XXXXXXXXXX",
        "type": "template",
        "template": {
            "name": "abandoned_cart",
            "language": {
                "code": "en_US"
            },
            "components": [             
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "subscription"
                        }
                    ]
                },             
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "This is the sample message"
                        }
                    ]
                },             
                {
                    "type": "button",
                    "sub_type": "mpm",
                    "index": 0,
                    "parameters": [
                        {
                            "type": "action",
                            "action": {
                                "thumbnail_product_retailer_id": "2lc20XXXpt",
                                "sections": [
                                    {
                                        "title": "Premium Packages",
                                        "product_items": [
                                            {
                                                "product_retailer_id": "2lc2XXXpt"
                                            },										
                                        ]
                                    },									
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    },
    "extra_info": {
        "ref": "customer1",
        "ref1": "marketing",
        "ref2": "dictionary",
        "wa_source": "api"
    }
}'

Following is the list of attributes to be used in the payload to send the outgoing message:

ParameterData TypeDescriptionExampleMandatory?
messaging_objectJSON objectPayload is supported only in JSON format. The messaging_object is the payload which contains the message object as defined by Meta which is used to send the WhatsApp message.See the specific table for details.Yes
extra_infoJSON objectThis object will contain additional details that a user can send for certain functionalities.See the specific table for details.No

The following table describes the different attributes used for the messaging_object JSON object:

Parameter Data Type Description Example Mandatory?

messaging_product

String

Messaging service used for the request.

The only allowed value is WhatsApp

Yes

recipient_type

String

Currently, you can only send messages to individuals. Default is individual.

The only allowed value is individual

No

to_number

String

A valid WhatsApp number of the recipient. Ensure that the country code is prefixed to the number. (E164 format).
Note: You can add multiple recipients, separate each number using the comma (,) delimiter.

+91XXXXXXXXXX

Yes

type

String

The type of message you want to send. If omitted, defaults to text.

The only allowed value is template

Yes

template

JSON Object

Contains the template information to be sent.

See the specific table for details

Yes

The following table describes the different attributes used for the template object.

ParameterData TypeDescriptionExampleMandatory?
template_nameStringSpecifies the template name. Note: The template_name must be approved by WhatsApp before you start using this API.abandoned_cartYes
languageJSON ObjectContains the template language information to be sent.See the specific table for detailsYes
componentsJSON ObjectThe components in the template.See the specific table for detailsYes

The following table describes the different attributes used for the language object.

ParameterData TypeDescriptionExampleMandatory?
language_codeStringThe template language and locale code.en_USYes

The following table describes the different attributes of the header-components.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of component used in the template.headerYes
parametersJSON ObjectThe type of value and the value associated with the header.See the specific table for detailsYes

The following table describes the different attributes of the header-parameters object.

ParameterData TypeDescriptionExampleMandatory?
typeStringDefines the type of headerOnly allowed value is textNo
header_textStringThe text that is used in the header.subscriptionYes

The following table describes the different attributes of the body-components.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of component used in the template.bodyYes
parametersJSON ObjectThe type of value and the value associated with the body.See the specific table for details

The following table describes the different attributes of the body-parameters object.

ParameterData TypeDescriptionExampleMandatory?
typeStringDefines the type of bodyOnly allowed value is textNo
body_textStringThe text that is used in the body.This is the sample messageYes

The following table describes the different attributes of the button-components.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of component used in the template.buttonYes
sub_typeStringType of button to create.Only allowed value is mpmYes
indexIntegerPosition index of the button. You can have up to 10 buttons using index values of 0 to 9.0Yes
parametersJSON Object or ArrayThe type of value and the value associated with the button.See the specific table for detailsYes

The following table describes the different attributes of the button-parameters object.

ParameterData TypeDescriptionExampleMandatory?
typeStringDefines the type of buttonactionYes
actionJSON ObjectThe button action when the button is clickedSee the specific table for detailsYes

The following table describes the different attributes used for the action object.

Parameter Data Type Description Example Mandatory?

thumbnail_product_retailer_id

String

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.

2lc20XXXpt

Yes

sections

JSON Object

Sections must be an array of objects describing each section using title and product_items.

See the specific table for details

Yes

The following table describes the different attributes used for the sections object:

Parameter Data Type Description Example Mandatory?

title

String

Section title text. You can define up to 10 sections. Maximum 24 characters.
Note: Markdown is not supported.

Premium Packages

Yes

product_items

JSON Object

Must be an array describing each product.

See the specific table for details

Yes

The following table describes the different attributes used for the product_items object:

Parameter Data Type Description Example Mandatory?

product_retailer_id

String

Stock Keeping Unit (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.

2lc2XXXpt

Yes


The following table describes the different attributes used for the extra_info object.

Parameter

Data Type

Description

Example

Mandatory?

ref

String

Include any contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.

customer1

No

ref1

String

Include the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.

marketing

No

ref2

String

Include the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.

dictionary

No

wa_source

String

Indicates the source from where the API has been triggered. Supported values for wa_source are "api", "clevertap", "zoho", "webengage", "shopify", "leadsquared", "responsys", "braze", "hubspot", "salesforce", "zapier", "eloqua", and "moengage".
Note: If the customer passes any other value other than above specified values, then the system will override that as the "API".

api

No

📘

Note:

In the case of ref, ref1, and ref2, if the length of the string exceeds 255 characters, it will be truncated.

Sample Success Response

The following success message appears with the status 202 Accepted:

202 Accepted 
{
"code":"WA202"
"message":"Request Accepted",
"data":{
  "message_id":"AXXXXXXXXXXXXXXXXXXX"
}
"error":{}
}

Sample Failure Response

The following are the failure responses:

401 Unauthorized
{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "error": "Incorrect SID or API key."
    }
}
401 Unauthorized phone number
{
    "code": "WA401",
    "message": "Phone number is not present or does not belong to the account.",
    "data": {},
    "error": {
        "phone_number": "Phone number is not present or does not belong to the account."
    }
}
400 Incorrect payload
{
    "code": "WA400",
    "message": "Refer to correct payload format",
    "data": {},
    "error": {
        "payload": "Incorrect payload format"
    }
}
500 Internal Server Error
{
    "code": "WA500",
    "message": "Please try again later",
    "data": {},
    "error": {
        "error": "Internal server error"
    }
}
400 Low balance
{
    "code": "E110",
    "message": "Please check your balance, You have a low balance!",
    "data": {},
    "error": {
        "balance": "Please check your balance, You have a low balance!"
    }
}
401 Unauthorised Account type
{
    "code": "WA-401",
    "message": "API is not available for given customer.Please contact support for more info",
    "data": {},
    "error": {
        "account": "API is not available for given customer.Please contact support for more info"
    }
}
401 Unauthorized phone number version
{
    "code": "WA-401",
    "message": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint.",
    "data": {},
    "error": {
        "phone_number": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint."
    }
}




© 2025 Kaleyra Inc. All rights reserved.
Trademarks, logos and service marks displayed on this site are registered and unregistered trademarks of Kaleyra Inc.