Send Message
Send Template
- GETGet Information
- POSTCreate Instance Basic
- GETFetch Instances
- GETInstance Connect
- PUTRestart Instance
- GETConnection State
- DELLogout Instance
- DELDelete Instance
- POSTSet Presence
- POSTSend Template
- POSTSend Plain Text
- POSTSend Status
- POSTSend Media
- POSTSend WhatsApp Audio
- POSTSend Sticker
- POSTSend Location
- POSTSend Contact
- POSTSend Reaction
- POSTSend Poll
- POSTSend List
- POSTCheck is WhatsApp
- PUTMark Message As Read
- PUTArchive Chat
- DELDelete Message for Everyone
- POSTSend Presence
- POSTFetch Profile Picture URL
- POSTFind Contacts
- POSTFind Messages
- POSTFind Status Message
- PUTUpdate Message
- GETFind Chats
- POSTFetch Business Profile
- POSTFetch Profile
- POSTUpdate Profile Name
- POSTUpdate Profile Status
- PUTUpdate Profile Picture
- DELRemove Profile Picture
- GETFetch Privacy Settings
- PUTUpdate Privacy Settings
- POSTCreate Group
- PUTUpdate Group Picture
- PUTUpdate Group Subject
- PUTUpdate Group Description
- GETFetch Invite Code
- GETAccept Invite Code
- PUTRevoke Invite Code
- POSTSend Group Invite
- GETFind Group by Invite Code
- GETFind Group by JID
- GETFetch All Groups
- GETFind Group Members
- PUTUpdate Group Members
- PUTUpdate Group Setting
- PUTToggle Ephemeral
- DELLeave Group
Início
Instances
Send Message
Chat Controller
Profile Settings
Profile Settings
Send Message
Send Template
Send a template message with the Official WhatsApp API
POST
https://{server-url}
/
message
/
sendTemplate
/
{instance}
server-url
string
server-url
string
The URL of your EvolutionAPI server
apikey
string
*
apikey
Required
string
Your authorization key header
instance
string
*
instance
Required
string
ID of the instance to connect
object
number
string
number
string
Message receiver number with country code
templateMessage
object
templateMessage
object
name
string
name
string
Template name
language
string
language
string
Template language
Add Example Value
components
array
components
array
Template components
curl --request POST \
--url https://{server-url}/message/sendTemplate/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"number": "<string>",
"templateMessage": {
"name": "<string>",
"language": "pt_BR",
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": "<string>",
"parameters": [
{
"type": "payload",
"text": "<string>"
}
]
}
]
}
}'Authorizations
apikey
string
headerrequiredYour authorization key header
Path Parameters
instance
string
requiredID of the instance to connect
Body
application/json
number
string
Message receiver number with country code
templateMessage
object
templateMessage.name
string
Template name
templateMessage.language
string
Template language
templateMessage.components
object[]
Template components
templateMessage.components.type
enum<string>
Available options:
header, body, button templateMessage.components.sub_type
enum<string>
Available options:
quick_reply, url, copy_code, catalog templateMessage.components.index
string
Button index from 0-9
templateMessage.components.parameters
object[]
templateMessage.components.parameters.type
enum<string>
Parameter type
Available options:
payload, text, coupon_code, currency, date_time, image, document, video templateMessage.components.parameters.text
string
Parameter text
curl --request POST \
--url https://{server-url}/message/sendTemplate/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"number": "<string>",
"templateMessage": {
"name": "<string>",
"language": "pt_BR",
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": "<string>",
"parameters": [
{
"type": "payload",
"text": "<string>"
}
]
}
]
}
}'