Sending Template Messages
It is only possible to send Templates with Active status. A message template status can change automatically from Active to Paused or Disabled based on feedback from customers. See Template Statuses.
Currently, you can send the following template types:
Text-based message templates: To send a text-based message template, make a
POST
call to the endpoint below and attach a text message object.Media-based message templates: When sending messages with media such as images, videos, or audio files, see our Media documentation to find details.
Interactive message templates: Interactive message templates expand the content you can send recipients beyond the standard message template and media messages template types to include interactive buttons.
Multi-Product Message templates: Showcase your products to customers directly from a template message.
Location-based message templates: Send location-based message templates.
Authentication templates with one-time password buttons: Specific Authentication Templates to authenticate and validate OTPs directly from WhatsApp.
API Reference
POST
https://waba-v2.360dialog.io/messages
Request Body
Name | Type | Description |
---|---|---|
to* | string | Recipient wa_id |
type* | string | Message type |
language* | string | Template language |
policy* | string | Delivery policy |
code* | string | Language code |
name* | string | Template name |
messaging_product* | string | Required for Cloud API.
Messaging service used for the request. Use |
[will be deprecated] If the WABA is registered in On-premise API
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.
POST
https://waba.360dialog.io/v1/messages
There is no limit to the number of parameters allowed in a Message Template.
Request Body
Name | Type | Description |
---|---|---|
to | string | Recipient wa_id |
type | string | Message type |
namespace | string | Template namespace |
language | string | Template language |
policy | string | Delivery policy |
code | string | Language code |
name | string | Template name |
Delivery Sequence of Multiple Messages
When sending a series of messages, the order in which messages are delivered is not guaranteed to match the order of your API requests. If you need to ensure the sequence of message delivery, confirm receipt of a delivered status in a messages webhook before sending the next message in your message sequence. See Webhooks and events.
Text Truncation for Marketing Messages
The rollout of the Text Truncation feature is currently gradual, so you may have experienced it during your campaigns. It is expected to reach all users by mid-October 2024.
Text Truncation impacts how users view marketing messages in their chat screens. It shortens, or "truncates," messages that exceed five (5) lines of text, displaying a clickable ‘Read more’ option. This allows users to view the complete message if they choose.
This update is part of WhatsApp's commitment to enhancing the user experience with marketing messages, helping clients achieve more value from marketing campaigns. Meta has implemented this change to boost user satisfaction while optimizing click-through rates (CTR). You should expect this update in Marketing Messages campaigns.
Initially, Text Truncation applies to the ‘Single image + text + click-to-action button(s)’ templates. Over time, it will extend to all formats of Marketing Messages, including group chats.
To maximize the impact of your marketing messages with this update, consider these best practices:
Make Your Message Engaging: Capture the user's attention quickly with content that speaks to their interests and interactions with the business.
Focus on the First 5 Lines: Create a clear and powerful opening with the first five lines. This is the text that will be visible to users, even when the message is truncated.
Build on Previous Interactions: Use past interactions with the user to craft a message that feels relevant and personalized.
Structure Longer Messages: If your message requires more than five lines, use distinct sections with clear spacing. Aim to keep your message concise, limiting to 3-4 well-defined sections.
Time-To-Live
If Meta is unable to deliver a message to a WhatsApp user, they will continue attempting to deliver the message for a period of time known as a time-to-live (TTL), or message validity period. If Meta is unable to deliver a message for an amount of time that exceeds the TTL, they will stop trying and drop the message.
The TTL for all messages, except for template messages that use an authentication template, is 30 days.
Template messages that use an authentication template have a default TTL of 10 minutes.
You can customize these defaults by setting a custom TTL on authentication templates and utility templates. See Customizing Time-To-Live.
If you send a message but do not receive a corresponding messages webhook indicating that the message was delivered before the TTL is exceeded, assume the message was dropped.
Note that if a message fails for some unrelated reason and it triggers a delivery failure messages webhook, there could be a minor delay before you receive the webhook, so you may wish to build in a small buffer before assuming a drop.
Template Pacing
Starting April 30, 2024, template pacing applies to both Marketing and Utility templates.
For Marketing Templates campaigns with fewer recipients that do not reach their 'pace limit', their messages will not be subjected to pacing. This 'pace limit' number is dynamically determined by Meta and may vary depending on the template or business.
Template pacing is a mechanism that allows time for customers to provide early feedback on newly created or unpaused marketing or utility templates. This identifies and pauses templates that have received poor feedback, giving the business time to adjust their contents before they are sent to too many customers, thereby reducing the likelihood of negative feedback impacting the business.
Template pacing is valid for utility and marketing templates. Newly created templates, paused templates that are unpaused, and templates that may have been created previously but don’t have a GREEN
quality rating are potentially subject to pacing. Template quality history — for example, low quality resulting in a template pause — is one of the primary reasons for template pacing and you may see other templates get paced.
When a template is paced, messages will be sent normally until an unspecified threshold is reached. Once this threshold is reached, subsequent messages using that template will be held to allow enough time for customer feedback. Once Meta receives a good quality signal, subsequent messages using that template will be scaled to the entire target audience. If they receive a bad quality signal, subsequent messages using that template will be dropped, giving the business the opportunity to adjust content, targeting, etc.
Utility Template Pacing
Utility templates are subject to pacing only if the number had a utility template paused. Once a utility template has been paused, newly created templates, paused templates that are unpaused, and templates that may have been created previously but don’t have GREEN
quality rating are potentially subject to pacing for the next 7 days.
API Behaviour
The immediate response from the messages endpoint will indicate if the message was sent (accepted
) or held (held_for_quality_assessment
) with the message_status
property in the message
object.
If the feedback is positive and changes the template's quality rating to high quality, the held messages will be released and sent normally which will trigger the sent
and delivered
webhooks. The message_template_quality_update
will send the quality update and the messages
webhook will send the sent and delivered updates.
If the feedback is negative and changes the template's quality to low quality:
The template's
status
will be set toPAUSED
A
message_template_quality_update
will be sent with anevent
value ofpaused
Each held message will be dropped and trigger a
messages
webhook with"status":"failed"
and"code":"132015"
(Cloud API users) or"code":"2061"
( On-Premises API users)A
message_template_quality_update
webhook will be triggered with the quality changeAdmins of the WhatsApp Business Account owning business will be informed of the dropped messages by Meta Business Suite notification, WhatsApp Manager banner, and email
See Template Pausing to learn how to unpause a template that has been paused due to pacing.
Note that Meta has internal guardrails in place to ensure that we evaluate and make a pacing decision within a reasonable time to avoid impact on time sensitive campaigns. The goal is that even if paced, campaign messages with highest throughput still get delivered within an hour (99 percentile).
Thus, if Meta internal guardrails are reached before a template has received enough feedback to change its quality to high or low, the held messages will be released normally along with any appropriate messages
webhooks. See Webhooks and events.
Per-User Marketing Template Message Limits
This feature is valid for all businesses worldwide starting from May 23, 2024.
Meta implemented a policy to limit the number of marketing conversations a user receives from any business over a specific timeframe, starting with a small number of conversations that are less likely to be read.
Note that the limit is determined based on the number of marketing template messages that person has already received from any business, and is not related to your business specifically.
The limit only applies to marketing template messages that would normally open a new marketing conversation. If a marketing conversation is already open between you and a WhatsApp user, marketing template messages sent to the user will not be affected. Further marketing template messages can only be sent in an open marketing conversation if the person responds to any message.
Example:
The first marketing template message is delivered and opens a new 24-hour marketing conversation customer service window. The per-user marketing template message limit applies.
A second marketing template message can be sent in an existing conversation.
Each time the WhatsApp user responds in an existing conversation window, you can send one additional marketing template message. You can also send unlimited free-form messages.
If a marketing template message is not delivered to a given user due to the limit, Cloud API will return error code 131049
with the description “This message was not delivered to maintain a healthy ecosystem engagement.” See error code: 131049
in Error Messages.
If you do receive one this error code and suspect it is due to the limit, avoid immediately resending the template message, as it will only result in another error response. Instead, retry in increasing larger time increments until the message is delivered, since the limit may be in effect for differing periods of time.
To understand more about these limits and how to adapt strategies, read our blog post on this subject.
Experiments
Meta's ongoing experiment on the WhatsApp Business Platform is focused on evaluating how marketing messages impact consumer experience and engagement. As part of this experiment, approximately 1% of WhatsApp consumers will not receive marketing messages.
Businesses will not be charged for undelivered messages. While there is no guaranteed timeframe for how long a number may be part of the experiment, we do not recommend retrying to send marketing messages to consumers with experimentation error codes unless there is an active conversation open. See Cloud API and On-Premise Experiments on Meta's Official Documentation.
Last updated