Skip to main content
POST
/
message
/
sendPoll
/
:instanceName
Send poll
curl --request POST \
  --url https://api.example.com/message/sendPoll/:instanceName \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "name": "<string>",
  "selectableCount": 123,
  "values": [
    {}
  ],
  "delay": 123
}
'
{
  "key": {
    "remoteJid": "<string>",
    "fromMe": true,
    "id": "<string>"
  },
  "message": {}
}

​
Request

Send a poll (voting) message to a WhatsApp number.
​
instanceName
string
required
Name of the instance

​
Body parameters

​
number
string
required
Recipient’s WhatsApp number with country code (e.g., “5511999999999”)
​
name
string
required
Poll question or title
​
selectableCount
number
required
Maximum number of options that can be selected (1 for single choice, >1 for multiple choice)
​
values
array
required
Array of poll options (strings)
​
delay
number
Delay in milliseconds before sending

​
Response

​
key
object
Message key information
​
message
object
Poll message details

​
Example request

curl -X POST https://your-api.com/message/sendPoll/my-instance \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "name": "What is your favorite color?",
    "selectableCount": 1,
    "values": [
      "Red",
      "Blue",
      "Green",
      "Yellow"
    ]
  }'

​
Notes

  • Set selectableCount to 1 for single-choice polls
  • Set selectableCount to a number greater than 1 for multiple-choice polls
  • Maximum number of poll options is 12
  • Poll results are visible to all participants
Polls are only supported on WhatsApp versions that support the poll feature. Older clients may not be able to vote.

Build docs developers (and LLMs) love

Get started for freeTalk to us