Overview

Variables allow you to personalise WhatsApp Template Messages by replacing placeholders with recipient-specific information when a message is sent. Instead of creating a separate template for every customer, you can use variables to insert names, order numbers, appointment dates, tracking IDs, and other dynamic values.

SPRL supports template variables for both WhatsApp campaigns and REST API messaging, making it easy to send personalised messages at scale.

Why Use Variables?

Example Template

A template can contain one or more numbered variables.

Types of Dynamic Content

WhatsApp templates in SPRL can contain different types of dynamic content. These are handled differently when the message is sent.

Using Variables in Campaigns

1. Navigate to Dashboard → WhatsApp → Campaigns.
2. Create a new campaign.
3. Select an approved template.
4. Provide values for each required body variable.
5. Provide values for any dynamic URL buttons.
6. Upload dynamic media if the template uses dynamic media.
7. Review the message preview.
8. Send or schedule the campaign.

Body Variables

Body variables are configured using numbered placeholders such as {{1}}, {{2}}, and {{3}}. Each required variable must receive a value before the campaign can be sent.

Dynamic URL Values

If the selected template contains a dynamic URL button, provide the value required by that button along with the body variables.

For example, if a template contains:

the value ORD12345 can be supplied when sending the message to produce a recipient-specific destination.

Dynamic Media

If the template uses dynamic media, upload the required image, video, or document when configuring the campaign.

Dynamic media is uploaded separately from text variables and does not occupy a numbered variable position.

Using Variables with the REST API

If you are sending messages through the REST API, include the variable values in your API request according to the selected template.

Body variable values must be provided in the same order as the variables defined in the template.

If the template contains a dynamic URL button, its dynamic value should be provided after the body variables in the same variables array.

Dynamic media is handled separately from the text variable array. When a template requires dynamic media, the required media file is uploaded with the API request.

Using Template Buttons

Templates can also include interactive buttons to improve customer engagement.

Dynamic URL Buttons

A Visit Website button can contain a dynamic URL value. This allows the same approved template to direct different recipients to different URLs.

Dynamic URL values are supplied after the body variables when using the REST API.

Dynamic Media

Templates can use dynamic media headers for images, videos, and documents.

Unlike body variables and dynamic URL values, dynamic media is not represented by {{1}}, {{2}}, or another numbered placeholder. The actual media file is supplied when the message is sent.

For example, a template can contain a dynamic document header and be used to send a different invoice PDF to each recipient when messages are created individually.

Variable Order

When a template contains both body variables and a dynamic URL button, SPRL processes the values in a defined order.

For example, if a template contains two body variables and one dynamic URL button, the API request should provide:

{ "variables": [ "John", "ORD12345", "ORD12345" ]
}

The first two values are used for the body and the third value is used for the dynamic URL button.

Button Guidelines

Best Practices

• Use variables only where personalised information is required.
• Verify every variable value before sending a campaign.
• Keep variable placement natural within the message.
• Keep body variables in the same order as defined by the template.
• Provide dynamic URL values after the body variables.
• Do not include dynamic media files inside the variables array.
• Ensure dynamic media matches the template's configured media type.
• Use descriptive button labels that clearly explain the action.
• Avoid creating unnecessary variables when static text is sufficient.
• Preview templates before sending large campaigns.

Troubleshooting

My variable isn't showing the expected value

Verify that a value has been provided for every required body variable and that the values are supplied in the correct order.

I cannot send the template

Ensure the template has been approved and all required variables have valid values.

My dynamic URL is not working

Make sure the URL button was configured as a dynamic URL and that the required dynamic value is provided after the body variables.

My dynamic media is not being sent

Make sure the template is configured for dynamic media and that the uploaded file matches the template's media type.

I cannot add more buttons

Templates support a maximum of 10 buttons. Individual button types also have their own limits.

My button label is too long

Button labels can contain up to 25 characters. Shorten the text before saving the template.

Frequently Asked Questions

Can I use multiple variables in one template?

Yes. A template can include multiple body variables wherever personalised information is required.

Can every recipient receive different variable values?

Yes. Variable values can be supplied individually for each message when it is sent.

Can I use variables with the REST API?

Yes. Body variable values can be provided through API requests as well as WhatsApp campaigns.

Can a dynamic URL button have a different value for every recipient?

Yes. Dynamic URL values can be supplied separately for each message.

Is dynamic media a variable?

No. Dynamic media is uploaded as a file and is handled separately from text variables.

Can I use dynamic media in campaigns?

Yes. A dynamic image, video, or document can be uploaded when configuring a campaign. A single dynamic media file is used for the campaign.

Can I send different media files to different recipients?

Yes, when sending messages individually through the REST API. Bulk campaigns support one dynamic media file per campaign.

What button types are supported?

Templates support Quick Reply, Visit Website, Call Phone, and Copy Code buttons.