Page Message Templates

To create a utility message template, send a POST request to the /<PAGE_ID>/message_templates endpoint with the following required parameters:

• name set to the name of the template
• language set to the language of the message text
• category set to UTILITY
• components set to an array of message components including an example with message values

Parameter Formats

Templates support two parameter formats:

• Named parameters — Placeholders use descriptive names: {{customer_name}}, {{order_id}}. Set parameter_format to NAMED when creating the template. Example values are provided in the body_text_named_params and header_text_named_params fields using param_name and example pairs.

• Positional parameters (default) — Placeholders use sequential numbers: {{1}}, {{2}}, {{3}}. Example values are provided in the body_text and header_text fields. This is the default format when parameter_format is not specified.

Text-Only Templates (Named Parameters)

In the following example, we use named parameters with descriptive placeholder names. The parameter_format is set to NAMED, and example values are provided using body_text_named_params and header_text_named_params with param_name and example pairs.

curl -H 'Content-Type: application/json' \
     -d '{
           "name": "jaspers_market_order_delivery_update_named_us",
           "language": "en",
           "category": "UTILITY",
           "parameter_format": "NAMED",
           "components": [
            {
              "type": "HEADER",
              "format": "TEXT",
              "text":"{{order_type}} Update",
              "example": {
               "header_text_named_params": [
                 {
                   "param_name": "order_type",
                   "example": "Order"
                 }
               ]
              }
             },
             {
               "type": "BODY",
               "text": "Good news! Your order #{{order_id}} is on its way. Thank you for your order, {{customer_name}}!",
               "example": {
                 "body_text_named_params": [
                   {
                     "param_name": "order_id",
                     "example": "566701"
                   },
                   {
                     "param_name": "customer_name",
                     "example": "John"
                   }
                 ]
               }
             }
           ]
         }' "https://graph.facebook.com/v25.0/102290129340398/message_templates?access_token=EAAJB..."

Text-Only Templates (Positional Parameters)

In the following example, we have message body text and header text. The body component and header component includes example customer information that would be used to customize the message.

curl -H 'Content-Type: application/json' \
     -d '{
           "name": "jaspers_market_order_delivery_update_us",
           "language": "en",
           "category": "UTILITY",
           "components": [
            {
              "type": "HEADER",
              "format": "TEXT",
              "text":"{{1}} Update",
              "example": {
               "header_text":["Order"]
              }
             },
             {
               "type": "BODY",
               "text": "Good news! Your order #{{1}} is on its way. Thank you for your order!",
               "example": {
                 "body_text": [
                   [
                     "566701"
                   ]
                 ]
               }
             }
           ]
         }' "https://graph.facebook.com/v25.0/102290129340398/message_templates?access_token=EAAJB..."

Text + Image Templates

You can also create templates with images. Images need to be first uploaded using the Resumable Upload API to generate the handle for the image. You can then use the handle and pass it in the Header component while creating the template.

curl -H 'Content-Type: application/json' \
     -d '{
           "name": "jaspers_market_order_delivery_update_named_us",
           "language": "en",
           "category": "UTILITY",
           "parameter_format": "NAMED",
           "components": [
             {
              "type": "HEADER",
              "format": "IMAGE",
              "text":"{{order_type}} Update",
              "example": {
               "header_handle": ["4:dGVzdF9pbWFn......."],
               "header_text_named_params": [
                 {
                   "param_name": "order_type",
                   "example": "Order"
                 }
               ]
              }
             },
             {
               "type": "BODY",
               "text": "Good news! Your order #{{order_id}} is on its way. Thank you for your order, {{customer_name}}!",
               "example": {
                 "body_text_named_params": [
                   {
                     "param_name": "order_id",
                     "example": "566701"
                   },
                   {
                     "param_name": "customer_name",
                     "example": "John"
                   }
                 ]
               }
             }
           ]
         }' "https://graph.facebook.com/v25.0/102290129340398/message_templates?access_token=EAAJB..."

On success your app receives a JSON response with the template ID, the review status, and the template category.

{
  "id": "104595129340398",
  "status": "APPROVED",
  "category": "UTILITY"
}