WhatsApp Templates

When you want to send WhatsApp Messages using MoEngage, use the templates that are already approved or whitelisted (directly or by the WhatsApp Service Provider or BSP) by WhatsApp in the MoEngage Platform.

Add Templates to MoEngage

info

Note

Ensure that you have access to all the approved WhatsApp templates before adding templates to MoEngage. You can access the templates from the BSP Dashboards.

To add your already approved/whitelisted WhatsApp templates in MoEngage, go to MoEngage Dashboard -> Settings -> WhatsApp -> Approved Templates. Click  + Template in the UI.

AddTemplates.png

info

Note

MoEngage does not validate your templates when you save them. Hence please make sure that they are matching exactly to your whitelisted templates else your campaign may fail because of template mismatch.

Template Settings

Screen_Shot_2022-03-25_at_3.17.17_PM.png

  1. Name (mandatory) - Enter the template name exactly similar to what you have on the BSP side. The name can be up to 100 characters
  2. Service Provider (mandatory) - Choose the service provider from the dropdown (or your BSP) with which you want to send this templated message. Please know that WhatsApp templates are approved on the WABA level which can belong to only 1 BSP. So select the BSP to which the template is approved with
  3. Sender Profile (mandatory) - Choose the sender profile to which this template is approved with. You can select multiple sender profiles if they are from the same BSP and are under the same WABA
  4. Language (mandatory) - It is the language of your template. Should be similar to what you have on the BSP/WSP side
  5. Category (mandatory) - Category of the template. WhatsApp allows sending messages that belong to one of the following categories:
    • Marketing
    • Utility
    • Authentication

Template Content

Message templates can be of 3 types

  1. Text
  2. Media (Image, Video, Document, Location) and
  3. Interactive (Quick Reply and Call to Action).

They are largely formed from 4 key components viz.

  1. Header,
  2. Body,
  3. Footer and
  4. Buttons.

As supported by WhatsApp, selective fields can be configured as:

Static - Static fields are fixed on the Template level. For example, static images can be used to send the same image in all messages to target users across all campaigns where this template is used.

Dynamic - Dynamic fields are flexible and can be configured during campaign creation. A dynamic image can be used to personalize for each campaign or each user in that campaign.

Dynamic Link Tracking - Dynamic link tracking allows you to track clicks on buttons with Navigation as an action. This is available only for Navigation buttons and for Gupshup as a provider.

f02bde24-3a02-4ba7-ab9d-6f8cc4517747.png

Headers

Headers are optional and can be of the following types:

  • Text (up to 60 characters, can include 1 placeholder)
  • Image

  • Video

  • Document

  • Location

The non-text header can be static or dynamic. They can use a fixed image or document link or personalized image/document for every user. Dynamic fields will be available for configuration at the time of campaign creation.

WATemplateHeader.png

Here are supported media types, media formats, and file sizes that MoEngage supports:

Content-Type Supported Format and file size
Image

The supported image types are JPG, JPEG, PNG. The maximum file size is 5MB.

Document

The supported document type is PDF. The maximum document size is 5MB.

Video

The supported file types are MP4, 3GPP. The maximum file size is 15MB.

Body

Body content is required and is a text field only. Bodies can contain up to 1024 characters and can be registered as plain text, or text with placeholders

For Example:

Hi {{1}},

We've received a payment of {{2}}.

Please reply here if you need any help.

 

The variables {{1}} or {{2}} can be replaced by using the personalization details to personalize the message for your audience

Footers

Footers are optional and are a text field only. Footers can contain up to 60 characters.

Buttons

Buttons are optional and templates can only contain one or the other button type. Button text can be up to 25 characters. The following button types are available:

  • Quick replies - You can have up to three quick reply buttons per message. Predefined replies which are set during template approval
  • Call-to-action - You can have up to two call-to-action buttons per message one for each action. Supported actions are Call a number and Visit a website

Template Management

To manage all your WhatsApp Templates, go to MoEngage Dashboard -> Settings -> WhatsApp -> Approved Templates. Once a template is added, you can manage your templates depending on if they are in use or not by a campaign.

Template  Usage Allowed Template Actions
Template not being used inside any campaign View, Edit, Duplicate, Delete

Template being used inside any campaign

View, Duplicate

Sync Templates from Vendors to MoEngage

MoEngage enables you to sync templates from configured partners to the MoEngage platform. Syncing templates will automatically retrieve all updated templates from the partner portals since the last updated time.

To sync templates:

  1. Go to MoEngage Dashboard > Settings > WhatsApp > Approved templates.
  2. Click Sync Template in the top right of the Approved templates tab.
    Template sync.png

After the sync is complete, one of the following messages is displayed:

  • Sync successful: All templates from connectors are synced to MoEngage successfully. You can see the summary of successful changes and also view the templates based on last updated time.
  • Sync failure: Templates sync from connectors to MoEngage failed. You can see the reasons for unsuccessful sync.
  • Mixed sync results: Templates sync from connectors to MoEngage is partially successful. For templates that are synced successfully, you can see the summary of successful changes; for templates that failed to sync, you can see the reasons for failures.

The following is the list of statuses after template sync:

Status Description Next Possible Actions
Created The template you created on the vendor portal is submitted for approval, but Meta is yet to approve it. Meta can approve or reject the template. You can create WhatsApp campaigns using this template.
Approved The template you created on the vendor portal is approved by Meta. You can use the approved template to create WhatsApp campaigns.
Rejected The template you created on the vendor portal is rejected by Meta.

You cannot use the rejected template to create WhatsApp campaigns.

When you edit a rejected template in MoEngage and save it, it will move to the Manually approved state. If the template is not exactly the same as the template on the vendor portal and you create WhatsApp campaigns using this template, the campaign creation will fail because of template mismatch. You must:

  1. Update the rejected template in the vendor portal and get the approval from Meta.
  2. Update the template in MoEngage with new content or Delete the template in MoEngage and sync again.
Suspended

After the initial sync of templates from the vendor portal to MoEngage, during subsequent sync:

  • If the content of a template on the vendor portal and MoEngage is same, we will update only the status. For example, a Manually approved template can move to Approved or an Approved template can move to Rejected.
  • If you have updated the content of a template on the vendor portal, we will mark it as Suspended because there is a difference of content between MoEngage and the vendor.

Click the ellipses icon ellipses.png and select View usage. The Active campaigns pop-up is displayed showing the campaigns created using this template.

  • If the template is not used in any campaign, delete the template in MoEngage and click Sync template again. MoEngage retrieves the latest content for it.
    To delete a suspended template:
    1. Stop the existing campaigns.
    2. Click the ellipses icon ellipses.png and select Delete.
  • If the template is used in any campaign(s), update the template in MoEngage and click Sync template again.
    To update content:
    • If a template is used in any campaign, edit the template in MoEngage and add the content manually to properly match the content on the vendor portal and save the template.
    • If you have added or removed any additional variables, ensure to add the details in campaigns.
    • To verify if the template content matches the content on partners portal, click Sync template.
Manually approved

When you edit a template in MoEngage and save it, it will move to the Manually approved state. If the template is not exactly the same as the template on the vendor portal and you create WhatsApp campaigns using this template, the campaign creation will fail because of template mismatch.

You must update the template in MoEngage to ensure that the content matches the content in the template in the vendor portal exactly.

 

info

Note

  • Currently, you can sync templates from Gupshup and it might take up to 15 mins to complete the sync.
  • For the first time sync, it will be synced for templates updated in the last 2 days.

Common Errors

Error Message Description Resolution
Invalid Authorization The sender details you added do not have a valid user name and password, authorization key, or account key.

Correct these details on the sender profile and sync templates again.

Internal Server Error This error occurs when MoEngage cannot resolve the API request. Please raise a support ticket for resolution.

 

Was this article helpful?
3 out of 12 found this helpful

How can we improve this article?