Skip to main content
POST
/
message
/
sendButtons
/
:instanceName
Send buttons
curl --request POST \
  --url https://api.example.com/message/sendButtons/:instanceName \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "title": "<string>",
  "description": "<string>",
  "footer": "<string>",
  "buttons": [
    {
      "type": "<string>",
      "displayText": "<string>",
      "id": "<string>",
      "url": "<string>",
      "phoneNumber": "<string>",
      "copyCode": "<string>"
    }
  ],
  "thumbnailUrl": "<string>",
  "delay": 123
}
'
{
  "key": {},
  "message": {}
}

Request

Send a message with interactive buttons that users can tap to perform actions.
instanceName
string
required
Name of the instance

Body parameters

number
string
required
Recipient’s WhatsApp number with country code (e.g., “5511999999999”)
title
string
required
Main title text of the message
description
string
Description or body text
Footer text displayed at the bottom
buttons
array
required
Array of button objects
thumbnailUrl
string
URL of an image thumbnail to display
delay
number
Delay in milliseconds before sending

Response

key
object
Message key information
message
object
Button message details

Example request

curl -X POST https://your-api.com/message/sendButtons/my-instance \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "title": "Choose an action",
    "description": "Select one of the options below",
    "footer": "Powered by Evolution API",
    "buttons": [
      {
        "type": "reply",
        "displayText": "Option 1",
        "id": "option-1"
      },
      {
        "type": "url",
        "displayText": "Visit Website",
        "url": "https://evolution-api.com"
      },
      {
        "type": "call",
        "displayText": "Call Us",
        "phoneNumber": "5511999999999"
      }
    ]
  }'

Button types

Reply buttons send a text response back when clicked. Use the id field to identify which button was clicked in webhook events.
{
  "type": "reply",
  "displayText": "Yes",
  "id": "confirm-yes"
}
URL buttons open a web link when clicked.
{
  "type": "url",
  "displayText": "Visit Website",
  "url": "https://example.com"
}
Call buttons initiate a phone call when clicked.
{
  "type": "call",
  "displayText": "Call Support",
  "phoneNumber": "5511999999999"
}
You can include up to 3 buttons in a single message. Button support varies by WhatsApp client version.

Build docs developers (and LLMs) love