Send Limited Time Offer Template Messages

The 'Send Limited Time Offer (LTO)’ code template API message enables you to send LTO code messages to customers.
The 'messaging_object' in the payload holds the information about the LTO code template used in the message. This object also holds information about the different components in the LTO template, such as the header, body, copy_code button, and URL button.
The extra_info part of the payload contains any additional information related to the API requests submitted to send the LTO code message.

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.

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 Limited Time Offer Code Template Message

To send LTO template message, use: 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 Limited Offer Template message.

curl -X POST \
  https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages \
  -H 'Content-Type: application/json' \
  -H 'api-key: <api-key>' \
  -H 'cache-control: no-cache' \
  -d  '{
    "messaging_object": {
        "messaging_product": "<messaging_product>",
        "recipient_type": "<recipient_type>",
        "to": "<to_number>",
        "type": "<type>",
        "template": {
            "name": "<template_name>",
            "language": {
                "code": "<template_language_code>"
            },
            "components": [
              
                {
                    "type": "<type>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "<header_type>": {
                                "id": "<header_asset_id>"
                            }
                        }
                    ]
                },
              
                {
                    "type": "<type>",
                    "parameters": [
                  	   <body_variables>
					]
                },
             
                {
                    "type": "<type>",
                    "parameters": [
                        {
                            "type": "<type>",
                            "limited_time_offer": {
                                "expiration_time_ms": <expiration_time>
                            }
                        }
                    ]
                },
      		
            {
                    "type": "<type>",
                    "sub_type": "<sub_type>",
                    "index": 0,
                    "parameters": [
                        {
                            "type": "<type>",
                            "coupon_code": "<offer_code>"
                        }
                    ]
                },
			
                {
                    "type": "<type>",
                    "sub_type": "<sub_type>",
                    "index": "<url_button_index>",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "<url_variable>"
                        }
                    ]
                }
            ]
        }
    },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

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": "+91xxxxxxxxx",
        "type": "template",
        "template": {
            "name": "LTO_template",
            "language": {
                "code": "en_US"
            },
            "components": [
              {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "image",
                            "image": {
                                      "id": "1602186516975000"
                                     }
                        }
                    ]
                },
                 {
                 "type": "body",
                 "parameters": [
                           {
                              "type": "text",
                              "text": "Pablo"
          			},
                         {
                  						"type": "text",
                  						"text": "CARIBE25"
                }
              ]
            },
              {
                    "type": "limited_time_offer",
                    "parameters": [
                      {
                        "type": "limited_time_offer",
                        "limited_time_offer": {
                          "expiration_time_ms": 1209600000
                        }
                      }
                    ]
                  },
      		    {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": 0,
                    "parameters": [
                      {
                        "type": "coupon_code",
                        "coupon_code": "CARIBE25"
                      }
                    ]
                  },
			          {
                          "type": "button",
                          "sub_type": "url",
                          "index": 1,
                          "parameters": [
                            {
                              "type": "text",
                              "text": "n3mtql"
                            }
                          ]
                        }
                      ]
                    }
                  }',
    "extra_info": {
        "ref": "customer1",
        "ref1": "marketing",
        "ref2": "dictionary",
        "wa_source": "api"
    }
}'

URL Parameters and Headers

Following is the list of parameters and headers to send the outgoing message request:


ParameterData TypeDescriptionExampleMandatory?
sidStringAccount SID (Security Identifier).HXAP16XXXXXX97INYes
phone_numberStringPhone number of end customer you want to send a message to.+91XXXXXXXXXXYes
Content-TypeStringIndicates the format of the content the API will be processing.The only value allowed is application/jsonYes
api-keyStringAPI key generated from Kaleyra platform account.Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3Yes

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.

Only allowed value is whatsapp

Yes

recipient_type

String

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

Only allowed value is individual

No

to

String

WhatsApp end-user phone number. The value should include country code prefix following E.164 format.

16XXXXXX234

Yes

type

String

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

Only allowed value for sending this message is
'template'.

No

template

JSON object

The template used to send the LTO code message.

See the specific table for details.

Yes

The following table describes the attributes of the 'template' object.

ParameterData TypeDescriptionExampleMandatory?
nameStringThe name of the template used.LTO_templateYes
languageJSON objectThe language used in the template.See the specific table for details.Yes
componentsJSON objectThe components in the template.See the specific table for details.Yes

The following table describes the attributes of the 'language' object.

ParameterData TypeDescriptionExampleMandatory?
codeStringThe code of the language used in the templateen_USYes

The following table describes the elements of the ‘components’ array for the 'header' parameters.

Parameter

Data Type

Description

Example

Mandatory?

type

String

The type of the component used in the template.
Note:
If the template uses 'header', then, this component is mandatory.

header

Yes

parameters

JSON object

The type of value and the value associated with the header.

See specific table for details

Yes

The following table describes the attributes of the 'parameters' object for ‘header’ component.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of the header used.ImageYes
imageJSON objectThe type of value and the value associated with the header.See specific table for detailsYes

The following table describes the attributes of the 'image' object.

ParameterData TypeDescriptionExampleMandatory?
idNumericID of the image used in the header component.1602186516975000Yes

The following table describes the attributes of ‘components’ for the 'body' element.

Parameter

Data Type

Description

Example

Mandatory?

type

String

The type of the component used in the template.
Note:
If the template uses 'body', then, this component is mandatory.

body

Yes

parameters

JSON object

The type of value and the value associated with the body.

See the specific table for more details.

Yes

The following table describes the attributes of the 'parameters' object related to the ‘body’ parameters.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of the body used.textYes
textStringThe text used in the body.PabloYes

The following table describes the attributes of the 'limited offer expiration' component.

Parameter

Data Type

Description

Example

Mandatory?

type

String

The type of the component used in the template.
Note:
If the template uses 'limited time offer', then, this component is mandatory.

limited_time_offer

Yes

limited_time_offer

JSON object

The limited_time_offer object description.

See the specific table for details.

Yes

The following table describes the attributes of the 'limited_time_offer' object.

ParameterData TypeDescriptionExampleMandatory?
expiration_time_msNumericA Unix timestamp to represent the expiration date in time in the unit of milliseconds.1209600000Yes

The following table describes the attributes of the 'copy_code' component.

Parameter

Data Type

Description

Example

Mandatory?

type

String

The type of the component used.
Note:
If the template uses 'Copy_Code' button, then, this component is mandatory.

Button

Yes

sub_type

String

The sub type of the button used.

copy_code

Yes

index

Numeric

The order in which the button should appear, if the template uses multiple buttons.

0

Yes

parameters

JSON object

The type of value and the value associated with the button.

See specific table for details

Yes

The following table describes the attributes of the 'parameters' object.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe type of parameter to be copied when the user taps the button.coupon_codeYes
coupon_codeStringThe coupon code that the user can copy to avail discount.2532334Yes

The following table describes the attributes of the 'URL button' component.

Parameter

Data Type

Description

Example

Mandatory?

type

String

The type of the component used.
Note: This button component is mandatory.

Button

Yes

sub_type

String

The sub type of the button used.

url

Yes

index

Numeric

The order in which the button should appear, if the template uses multiple buttons.

1

Yes

parameters

JSON object

The type of value and the value associated with the button.

See specific table for details

Yes

The following table describes the URL button 'parameters' object.

ParameterData TypeDescriptionExampleMandatory?
typeStringThe value associated with the URL button.textYes
textStringThe URL text associated with the button.n3mtqlYes

The following table describes the different attributes used for the extra_info JSON 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


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":{}
}

Failure Responses

Following are the error responses for the API level and the business level validations.

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.