Utility Template Library

The Utility Template Library makes it faster and easier for businesses to create utility templates for common use cases, like payment reminders, delivery updates and more.

These pre-written templates have already been categorized and priced as utility. These templates contain fixed content that cannot be edited and parameters you can adapt for business or user-specific information.

You can browse and create templates using the Utility Template Library in WhatsApp Manager, or programmatically via the API.

Creating Templates via WhatsApp Manager (WAM)

Follow the instructions below to create templates using the Utility Template Library in WhatsApp Manager .

1: In the sidebar of WAM, under Message Templates, select Create Template.

2: Under Browse the WhatsApp Template Library , select Browse Templates.

3: You will now see all currently available utility templates. Use the search bar to search by topic or use case, or use the dropdown options on the sidebar to filter the results.

Note that hovering over a template will show you its parameter values.

4: To create a template, select oneby clicking on it. Then, add your template name, select the language, and fill out the button details. Once you have completed these steps, click Submit.

Note: If you choose Customize template, your template will have to go through review before you are able to send messages.

Template Parameters and Restrictions

The templates in the library contain both fixed content and parameters. The parameters represent spaces in the template where variable information can be inserted, such as names, addresses, and phone numbers.

In the example above, parameters like the name Jim or the business name CS Mutual can be modified to accept variables like your customer's name and your business's name.

Messages sent using templates from Utility Template Library are subject to parameter checks during send time. Values used in parameters that are outside of the established ranges listed below will cause the message send to fail.

List of parameters and sample values

Forms

Some templates in Utility Template Library are interactive forms that are powered by WhatsApp Flows.

In WhatsApp Manager, you can identify these specific templates by the "Form" label they contain. The current supported use cases are Customer Feedback and Delivery Failure.

Identifying forms in the request response

When calling the GET /message_template_library endpoint, the type key in the buttons array will show as "FORMS" .

{
      "name": "delivery_failed_2_form",
      "language": "en_US",
      "category": "UTILITY",
      "topic": "ORDER_MANAGEMENT",
      "usecase": "DELIVERY_FAILED",
      "industry": [
        "E_COMMERCE"
      ],
      "body": "We were unable to deliver order {{1}} today. 

Please {{2}} to schedule another delivery attempt.",
      "body_params": [
        "#12345",
        "try a redelivery"
      ],
      "body_param_types": [
        "TEXT",
        "TEXT"
      ],
      "buttons": [
        {
          "type": "FLOW",
          "text": "Reschedule"
        }
      ],
      "id": "7138055039625658"
},

Using the API

The Utility Template Library API has two endpoints:

// Used to browse available utility templates
GET /message_template_library

// Used when you are ready to create a template from the library.
POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Searching and Filtering Available Utility Templates

To browse and filter available templates, use the message_template_library endpoint.

Once you find the template you are interested in, note the name as you will use it when creating the template via the POST method.

Request Syntax

// Get all available templates
GET /message_template_library

// Search for substring
GET /message_template_library?search=<SEARCH_KEY>

// Filter by template topic
GET/message_template_library?topic=<TOPIC>

// Filter by template use case
GET/message_template_library?usecase=<USECASE>

// Filter by template industry
GET/message_template_library?industry=<INDUSTRY>

// Filter by template language
GET/message_template_library?language=<LANGUAGE>

Query String Parameters

Example Request

curl 'https://graph.facebook.com/ v20.0 
/102290129340398/message_templates?search="payments"'
-H 'Authorization: Bearer EAAJB...'

Example Response

{
      "name": "low_balance_warning_1",
      "language": "en_US",
      "category": "UTILITY",
      "topic": "PAYMENTS",
      "usecase": "LOW_BALANCE_WARNING",
      "industry": [
        "FINANCIAL_SERVICES"
      ],
      "header": "Your account balance is low",
      "body": "Hi {{1}}, 
This is to notify you that your {{2}} in your {{3}} account, ending in {{4}} is below your pre-set {{5}} of {{6}}. 
Click the button to deposit more {{7}}.
{{8}}",
      "body_params": [
        "Jim",
        "available funds",
        "CS Mutual checking plus",
        "1234",
        "limit",
        "$75.00",
        "funds",
        "CS Mutual"
      ],
      "buttons": [
        {
          "type": "URL",
          "text": "Make a deposit",
          "url": "https://www.example.com/"
        },
        {
          "type": "PHONE_NUMBER",
          "text": "Call us",
          "phone_number": "+18005551234"
        }
      ],
      "id": "7147013345418927"
}

Template Filters

There are several templates to choose from in the Utility Template Library. You can use the API to filter them based on a few factors.

List of Industry, Topic, and Use Case Enums

Creating Utility Templates

To create a new template using the Utility Template Library, call the existing <WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates endpoint using the body properties below.

Request Syntax

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Post Body

{
  "name": "<NAME>",
  "category": "UTILITY",
  "language": "en_US",
  “library_template_name”: “<LIBRARY_TEMPLATE_NAME>”,
  "library_template_button_inputs": "[
    {'type': 'URL', 'url': {'base_url' : 'https://www.example.com/{{1}}',
    'url_suffix_example' : 'https://www.example.com/demo'}},
    {type: 'PHONE_NUMBER', 'phone_number': '+16315551010'}
]"
}

Body Properties

Example Request

curl 'https://graph.facebook.com/v19.0/102290129340398/message_templates'
-H 'Authorization: Bearer EAAJB...'
-H 'Content-Type: application/json'
-d '
{
  "name": "my_delivery_update",
  "language": "en_US",
  "category": "UTILITY",
  “library_template_name”: “delivery_update_1”,
  "library_template_button_inputs": "[
    {'type': 'URL', 'url': {'base_url' : 'https://www.example.com/{{1}}',
    'url_suffix_example' : 'https://www.example.com/order_update}}
  ]"
}

Example Response

{
  "id": "{hsm-id}",
  "status": "APPROVED",
  "category": "UTILITY"
}

Sending Utility Template Messages

To learn how to send templated messages, view the Send Templates guide