Graph API Version

WhatsApp Message Template

Represents a specific message template. Make the API call to the message template ID.

To find a message template ID, call https://graph.facebook.com/{api-version}/{whatsapp-business-account-ID}/message_templates.

For more information on how to use the API, see WhatsApp Business Management API.

Reading

Retrieves information about the message template

Example

Requirements

whatsapp_business_management permission
whatsapp_business_messaging permission
public_profile permission
WHATSAPP MESSAGE TEMPLATE ID
USER ACCESS TOKEN

Request

curl -i -X GET \
 "https://graph.facebook.com/LATEST-VERSION/WHATS-APP-MESSAGE-TEMPLATE-ID?access_token=USER-ACCESS-TOKEN"

GraphRequest request = GraphRequest.newGraphPathRequest(
  accessToken,
  "/WHATS-APP-MESSAGE-TEMPLATE-ID",
  new GraphRequest.Callback() {
    @Override
    public void onCompleted(GraphResponse response) {
      // Insert your code here
    }
});

request.executeAsync();

FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
    initWithGraphPath:@"/WHATS-APP-MESSAGE-TEMPLATE-ID"
           parameters:nil
           HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection, id result, NSError *error) {
    // Insert your code here
}];

Response

{
  "name": "shiptest",
  "components": [
    {
      "type": "BODY",
      "text": "testing"
    }
  ],
  "language": "en_US",
  "status": "REJECTED",
  "category": "TRANSACTIONAL",
  "id": "WHATS-APP-MESSAGE-TEMPLATE-ID"
}

Parameters

This endpoint doesn't have any parameters.

Fields

Field	Description
`id` numeric string	ID
`bid_spec` WhatsAppBusinessHSMWhatsAppBusinessBidSpec	bid_spec
`category` enum	The category type of the message template Default
`components` list<WhatsAppBusinessHSMWhatsAppHSMComponentGet>	An array of JSON objects describing the message template components. Default
`correct_category` enum	The correct category for the template. Default
`cta_url_link_tracking_opted_out` bool	Optional boolean field for opting out/in of link tracking at template level
`degrees_of_freedom_spec` WhatsAppBusinessHSMMarketingMessageDegreesOfFreedomSpec	degrees_of_freedom_spec
`language` string	The language (and locale) of the element translation Default
`library_template_name` string	Template Library name that this HSM is clone from Default
`message_send_ttl_seconds` integer	Template message delivery retry time-to-live (TTL) override value. If we are unable to deliver a message to a WhatsApp user, 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. Default
`name` string	The message template name Default
`optimization_spec` WhatsAppBusinessHSMTMMApiOptimizationSpecForGraphAPI	optimization_spec
`parameter_format` enum	The parameter format, can be Named or Positional Default
`previous_category` enum	Previous category of the template. See Template Categories. Default
`product_set_id` numeric string	product_set_id is required for Dynamic Product Messages. Coming Soon! Default
`quality_score` WhatsAppBusinessHSMWhatsAppBusinessHSMQualityScoreShape	Quality score of the HSM
`rejected_reason` enum	The reason the message template was rejected enum {ABUSIVE_CONTENT, INVALID_FORMAT, NONE, PROMOTIONAL, TAG_CONTENT_MISMATCH, SCAM}
`status` enum	The status of the message template. Values can be: `APPROVED` — Indicates the template has been reviewed, approved, and can now be sent in template messages. `IN_APPEAL` — Indicates the template is in the rejection appeal process and cannot be sent. `PENDING` — Indicates the template is still undergoing template review and cannot be sent. `REJECTED` — Indicates the template has been reviewed and rejected and cannot be sent. `PENDING_DELETION` — Indicates the template is undergoing deletion and cannot be sent. `DELETED` — Indicates the template has been deleted and cannot be sent. `DISABLED` — Indicates the template has been disabled due to poor template quality and cannot be sent. `PAUSED` — Indicates the template has been paused due to poor template quality and cannot be sent. `LIMIT_EXCEEDED` — Indicates the template has been paused due to template pacing. Default
`sub_category` enum	Sub category of the template Default

Edges

Edge Description

Edge	Description
`compare` Edge<WhatsAppBusinessHSMComparison>	compare

compare

Edge<WhatsAppBusinessHSMComparison>

compare

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
104	Incorrect signature

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.

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
`bid_strategy` enum {COST_CAP, LOWEST_COST_WITH_BID_CAP, LOWEST_COST_WITH_MIN_ROAS, LOWEST_COST_WITHOUT_CAP}	bid_strategy
`start_time` string	start_time
`end_time` string	end_time
`lifetime_budget` int64	lifetime_budget
`daily_budget` int64	daily_budget
`bid_amount` int64	bid_amount
`bid_country_multiplier_overrides` JSON object {enum {AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW} : float}	bid_country_multiplier_overrides
`optimization_goal` enum {LINK_CLICKS, OFFSITE_CONVERSIONS, REACH, VALUE}	optimization_goal
`status` enum {ACTIVE, ARCHIVED, DELETED, PAUSED}	status
`whatsapp_business_phone_number_id` numeric string	whatsapp_business_phone_number_id
`targeting` JSON object	targeting
`custom_audiences` array<numeric string>	custom_audiences Required
`excluded_custom_audiences` array<numeric string>	excluded_custom_audiences
`promoted_object` JSON object	promoted_object
`pixel_id` string	pixel_id
`custom_event_type` enum {ADD_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, COMPLETE_REGISTRATION, CONTENT_VIEW, INITIATED_CHECKOUT, LEAD, LEVEL_ACHIEVED, PURCHASE, RATE, SUBSCRIBE, TUTORIAL_COMPLETION}	custom_event_type
`application_id` string	application_id
`attribution_spec` array<JSON object>	attribution_spec
`event_type` enum {CLICK_THROUGH}	event_type Required
`window_days` int64	window_days Required
`adset_schedule` array<JSON object>	adset_schedule
`start_minute` int64	start_minute Required
`end_minute` int64	end_minute Required
`days` array<int64>	days Required
`timezone_type` enum {ADVERTISER, USER}	timezone_type
`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 update a WhatsAppMessageTemplate by making a POST request to /{whats_app_message_template_id}.

Parameters

Parameter	Description
`category` enum {UTILITY, MARKETING, AUTHENTICATION}	category
`components` array<JSON object>	The array containing all the content of the message template
`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
`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
`flow_name` string	flow_name
`flow_json` string	flow_json
`icon` enum {DOCUMENT, PROMOTION, REVIEW}	icon
`creative_sourcing_spec` JSON object	creative_sourcing_spec
`associated_product_set_id` numeric string	The associated product set id
`message_send_ttl_seconds` int64	Template message delivery retry time-to-live (TTL) override value.If we are unable to deliver a message to a WhatsApp user, we will retry the delivery for a period of time known as a time-to-live, TTL, or the message validity period. If we are unable to deliver the message for this period of time, the message will be dropped. TTL can be configured for certain message types. See Time-To-Live.
`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.

Return Type

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

Struct {

success: bool,

id: string,

name: string,

category: string,

}

Error Codes

Error	Description
100	Invalid parameter
131009	Parameter value is not valid
192	Invalid phone number
200	Permissions error
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.

Deleting

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

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.