Send Media Message Template

Once the WhatsApp media message template has been created via UI or API and approved, the next step is sending the template to the end users through the Messages API.

To know how to send a media message template go to the Send a Media Message Template section.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
placeholders
object

Only applies if the ´BODY´ type contains personalized fields (placeholders).

Object of personalized fields (placeholders) containing the text message body.

From the ´placeholders´ object, set as parameter the placeholder you configured that is inside double curly braces {{...}} when creating the template. Then set the value of the placeholder parameter.

The placeholders must be correctly formatted in order of how the template was created.

For example, for a text message body like “Here is your {{code}}”, you would set the placeholder as ´code´: ´34871´.

string

Name of the template created in your WhatsApp Business Account.

string

Template Language you set when creating the template.

Currently the API supports 3 Languages: English, Spanish and Portuguese. Required if you want to send templates in languages other than English.

English: ´en´

Spanish: ´es´

Portuguese: ´pt_BR´, ´pt_PT

string
required

Phone number of the sender.

Phone number provided during the WABA account setup will be used as the sender of the notification message.

Only accepts numeric characters. Do not include the ´+ sign.

string
required

Determines the destination phone number for your template message. Numbers are specified in E.164 format → (‘+’ and a country code).

string

Unique identifier of the template.

callbacks
array of strings
callbacks
templateHeader

Only applies if the template created contains the ´HEADER´ type with a personalized field (placeholder)in the text header or an URL based on the chosen media header (image, video, document).

Object of personalized fields (placeholders) or URL containing the header type chosen when creating the template.

templateButtons
array

Only applies if the template created contains the ´BUTTONS´ type with a Dynamic URL or Quick Reply buttons.

if you set the Call To Action as Button type, it is required when the button contains a Dynamic URL.

if you set the Quick Reply as Button type, it is required when the button contains a payload or keywords.

Array that contains the URL Suffix value (placeholder) of Dynamic URL for a Call To Action Button, and payloads or keywords from Quick Reply Buttons containing the button type chosen when creating the template.

templateButtons
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json