Graph API Version

Whats App Business Account Message Templates

Represents a collection of templates on a WhatsApp Business Account. See Templates.

Reading

Get a list of templates on a WhatsApp Business Account.

Requirements

Type	Description
Access Tokens	User, System User, or Business Integration System User
Permissions	whatsapp_business_management

Request Syntax

GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates
  ?category=<CATEGORY>,
  &content=<CONTENT>,
  &language=<LANGUAGE>,
  &name=<NAME>,
  &name_or_content=<NAME_OR_CONTENT>,
  &quality_score=<QUALITY_SCORE>,
  &status=<STATUS>

Path Parameters

Placeholder	Value
`<WHATSAPP_BUSINESS_ACCOUNT_ID>`	WhatsApp Business Account ID.

Response

A list of WhatsApp Message Template nodes.

Sample Request

curl 'https://graph.facebook.com/v16.0/102290129340398/message_templates?category=utility' \
-H 'Authorization: Bearer EAAJB...'

Sample Response

{
  "data": [
    {
      "name": "order_delivery_update",
      "components": [
        {
          "type": "HEADER",
          "format": "LOCATION"
        },
        {
          "type": "BODY",
          "text": "Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!",
          "example": {
            "body_text": [
              [
                "Mark",
                "566701"
              ]
            ]
          }
        },
        {
          "type": "FOOTER",
          "text": "To stop receiving delivery updates, tap the button below."
        },
        {
          "type": "BUTTONS",
          "buttons": [
            {
              "type": "QUICK_REPLY",
              "text": "Stop Delivery Updates"
            }
          ]
        }
      ],
      "language": "en_US",
      "status": "APPROVED",
      "category": "UTILITY",
      "id": "1667192013751005"
    },
    ...
  ],
  "paging": {
    "cursors": {
      "before": "MAZDZD",
      "after": "MjQZD"
    }
  }
}

Parameters

Parameter	Description
`category` array<enum {ACCOUNT_UPDATE, PAYMENT_UPDATE, PERSONAL_FINANCE_UPDATE, SHIPPING_UPDATE, RESERVATION_UPDATE, ISSUE_RESOLUTION, APPOINTMENT_UPDATE, TRANSPORTATION_UPDATE, TICKET_UPDATE, ALERT_UPDATE, AUTO_REPLY, TRANSACTIONAL, OTP, UTILITY, MARKETING, AUTHENTICATION, FREE_SERVICE}>	The category for a template
`content` string	The content for a template
`language` array<string>	A list of supported languages that are available for each template
`name` string	The name for a message template
`name_or_content` string	Returns a list of message templates where the value for `name` or `content` match this value
`quality_score` array<enum {GREEN, YELLOW, RED, UNKNOWN}>	The quality score for a template
`since` datetime/timestamp	Query param to fetch templates based on last_updated_time since a given unix timestamp
`status` array<enum {APPROVED, IN_APPEAL, PENDING, REJECTED, PENDING_DELETION, DELETED, DISABLED, PAUSED, LIMIT_EXCEEDED, ARCHIVED}>	The review status for a template
`until` datetime/timestamp	Query param to fetch templates based on last_updated_time until a given unix timestamp

Fields

Reading from this edge will return a JSON formatted result:

{
    "data": [],
    "paging": {},
    "summary": {}
}

`data`

A list of WhatsAppMessageTemplate nodes.

`paging`

For more details about pagination, see the Graph API guide.

`summary`

Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=total_count).

Field	Description
`total_count` unsigned int32	The total number of message templates that belong to a WhatsApp Business Account
`message_template_count` int32	The current number of message templates that belong to the WhatsApp Business Account
`message_template_limit` int32	The maximum number of message templates that can belong to a WhatsApp Business Account
`are_translations_complete` bool	The status for template translations

Error Codes

Error	Description
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
100	Invalid parameter
200	Permissions error
190	Invalid OAuth 2.0 Access Token

Creating

You can make a POST request to message_templates edge from the following paths:

/{whats_app_business_account_id}/message_templates

When posting to this edge, a WhatsAppMessageTemplate will be created.

Type	Description
Access Tokens	User, System User, or Business Integration System User
Permissions	whatsapp_business_management

Request Syntax

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Path Parameters

Placeholder	Value
`<WHATSAPP_BUSINESS_ACCOUNT_ID>`	ID of the WhatsApp Business Account to create the template on.

Post Body

See Parameters for property descriptions.

{
  "allow_category_change": <ALLOW_CATEGORY_CHANGE>,
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "<CATEGORY>",
  "components": [<COMPONENTS>]
}

Response

See Return Type.

Sample Request

curl 'https://graph.facebook.com/v25.0/102290129340398/message_templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "name": "seasonal_promotion",
  "language": "en",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Our {{1}} is on!",
      "example": {
        "header_text": [
          "Summer Sale"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.",
      "example": {
        "body_text": [
          [
            "the end of August","25OFF","25%"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "Use the buttons below to manage your marketing subscriptions"
    },
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubcribe from Promos"
        },
        {
          "type":"QUICK_REPLY",
          "text": "Unsubscribe from All"
        }
      ]
    }
  ]
}'

Sample Response

{
    "id": "594425479261596",
    "status": "PENDING",
    "category": "MARKETING"
}

Parameters

Parameter	Description
`allow_category_change` boolean	Set to `true` to allow us to assign a category based on our template guidelines and the template's contents. This can prevent the template `status` from immediately being set to `REJECTED` upon creation due to miscategorization. If omitted, template will not be auto-assigned a category and its status may be set to `REJECTED` if determined to be miscategorized. See Template Categories.
`category` enum {UTILITY, MARKETING, AUTHENTICATION}	Template category. See Template Categories. Required
`components` array<JSON object>	Array of components that make up the template. See Template Components. For types `HEADER`, `BODY`, `FOOTER`, `text` is required.
`type` enum {GREETING, HEADER, BODY, FOOTER, BUTTONS, CAROUSEL, ALBUM, LIMITED_TIME_OFFER, CALL_PERMISSION_REQUEST, TAP_TARGET_CONFIGURATION, ATTACHMENT}	Component type. Required
`format` enum {TEXT, IMAGE, DOCUMENT, VIDEO, LOCATION, GIF, COLLECTION}	Component format.
`text` string	Required for components with type `HEADER`,`BODY` Component text.
`buttons` array<JSON object>	Button components to be used in the template.
`type` enum {QUICK_REPLY, URL, PHONE_NUMBER, OTP, MPM, CATALOG, FLOW, VOICE_CALL, VIDEO_CALL, POSTBACK, BOOKING_STATUS, PAYMENT_REQUEST, REQUEST_CONTACT_INFO}	Button type. Required
`text` string	Button text.
`url` URI	url
`phone_number` phone number string	phone_number
`example` array<string>	example
`flow_id` int64	flow_id
`zero_tap_terms_accepted` boolean	zero_tap_terms_accepted
`flow_action` enum {NAVIGATE, DATA_EXCHANGE}	flow_action
`navigate_screen` string	navigate_screen
`supported_apps` array<JSON object>	supported_apps
`package_name` string	package_name Required
`signature_hash` string	signature_hash Required
`ttl_minutes` int64	ttl_minutes
`flow_name` string	flow_name
`flow_json` string	flow_json
`icon` enum {DOCUMENT, PROMOTION, REVIEW}	icon
`endpoint_uri` URI	endpoint_uri
`example` JSON object	Placeholder examples. Templates will not be approved without examples.
`header_text` array<string>	header_text
`body_text` array<array<string>>	body_text
`header_handle` array<string>	header_handle
`header_text_named_params` array<JSON object>	header_text_named_params
`param_name` string	param_name Required
`example` string	example Required
`body_text_named_params` array<JSON object>	body_text_named_params
`param_name` string	param_name Required
`example` string	example Required
`creative_sourcing_spec` JSON object	Defines the ACO dimensions specification the Biz can opt in or out of.
`associated_product_set_id` numeric string	The associated product set id
`is_primary_device_delivery_only` boolean	is_primary_device_delivery only
`language` string	Template location and locale code. Required
`library_template_body_inputs` JSON object	Optional data during creation of a template from a library template. These are optional fields for the body component.
`add_contact_number` boolean	add_contact_number
`add_learn_more_link` boolean	add_learn_more_link
`add_security_recommendation` boolean	add_security_recommendation
`add_track_package_link` boolean	add_track_package_link
`code_expiration_minutes` int64	code_expiration_minutes
`library_template_button_inputs` array<JSON object>	Optional data during creation of a template from a library template. These are optional fields for the button component.
`type` enum {QUICK_REPLY, URL, PHONE_NUMBER, OTP, MPM, CATALOG, FLOW, VOICE_CALL, VIDEO_CALL, POSTBACK, BOOKING_STATUS, PAYMENT_REQUEST, REQUEST_CONTACT_INFO}	type Required
`phone_number` string	phone_number
`url` JSON object	url
`base_url` string	base_url Required
`url_suffix_example` string	url_suffix_example
`otp_type` enum {COPY_CODE, ONE_TAP, ZERO_TAP, NO_BUTTONS}	otp_type
`zero_tap_terms_accepted` boolean	zero_tap_terms_accepted
`supported_apps` array<JSON object>	supported_apps
`package_name` string	package_name Required
`signature_hash` string	signature_hash Required
`booking_url` JSON object	booking_url
`base_url` string	base_url Required
`url_suffix_example` string	url_suffix_example
`booking_management_url` JSON object	booking_management_url
`base_url` string	base_url Required
`url_suffix_example` string	url_suffix_example
`notes` JSON object	notes
`text` string	text Required
`positional_params` array<string>	positional_params
`named_params` array<JSON object>	named_params
`param_name` string	param_name Required
`example` string	example Required
`library_template_name` string	library_template_name
`message_send_ttl_seconds` int64	Time to live for message template sent. If users are offline for more than TTL duration after message template is sent, we will retry the delivery for a period of time known as a time-to-live, TTL, or the message validity period. TTL can be configured for certain message types. See Time-To-Live.
`name` string	Template name. Required
`optimization_spec` JSON object	optimization_spec
`parameter_format` enum {NAMED, POSITIONAL}	The parameter format of the template
`product_set_id` numeric string	[Coming soon] This will let you connect a product set (from your catalog) to the template and send messages without needing to specify products in the send API call. Our product recommendation engine will select the products your customers are most interested in and likely to convert. This feature is called Dynamic Product Message. Note: This is still in development.
`sub_category` enum {ORDER_DETAILS, ORDER_STATUS, RICH_ORDER_STATUS}	Sub category of the template

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

id: numeric string,

status: enum,

category: enum,

}

Error Codes

Error	Description
100	Invalid parameter
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
131009	Parameter value is not valid
192	Invalid phone number
200	Permissions error
368	The action attempted has been deemed abusive or is otherwise disallowed
200002	HSM Template creation failed
139000	Blocked by Integrity

Updating

You can't perform this operation on this endpoint.

Deleting

You can dissociate a WhatsAppMessageTemplate from a WhatsAppBusinessAccount by making a DELETE request to /{whats_app_business_account_id}/message_templates.

Type	Description
Access Tokens	User, System User, or Business Integration System User
Permissions	whatsapp_business_management

Request Syntax

DELETE /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Path Parameters

Placeholder	Value
`<WHATSAPP_BUSINESS_ACCOUNT_ID>`	ID of the WhatsApp Business Account that owns the template.

Response

See Return Type.

Sample Request

curl -X DELETE 'https://graph.facebook.com/v25.0/102290129340398/message_templates?name=order_confirmation' \
-H 'Authorization: Bearer EAAJB...'

Sample Response

{
  "success": true
}

Parameters

Parameter Description

Parameter	Description
`hsm_id` numeric string	ID of template to be deleted. Required with name if deleting a specific template by ID.
`hsm_ids` array<numeric string>	IDs of all the templates for bulk deletion. Required if you wish to delete templates in bulk
`name` string	Name of template to be deleted. Deletes templates matching the name in all languages

hsm_id

numeric string

ID of template to be deleted. Required with name if deleting a specific template by ID.

hsm_ids

array<numeric string>

IDs of all the templates for bulk deletion. Required if you wish to delete templates in bulk

name

string

Name of template to be deleted. Deletes templates matching the name in all languages

Return Type

Struct {

success: bool,

}

Error Codes

Error	Description
100	Invalid parameter
200	Permissions error
190	Invalid OAuth 2.0 Access Token
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.