Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-poll
Send poll
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "poll": [
    {
      "name": "<string>"
    }
  ]
}
'

​
Overview

With this method you can send poll messages.
Sending polls is only available for groups, following WhatsApp Web behavior.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Recipient group ID. This ID can be obtained through the get/chats method
​
message
string
required
Poll text
​
poll
array
required
Poll option list

​
Optional

​
delayMessage
number
Delay added to the message. You can choose between a range of 1 to 15 sec, meaning how many seconds it will wait before sending the next message. (E.g.: “delayMessage”: 5). The default delay if not provided is 1 to 3 sec
​
pollMaxOptions
number
Maximum number of votes per person in the poll

​
Request Body

Multiple choice: 
{
  "phone": "5511999999999-1234567890@g.us",
  "message": "What is the best WhatsApp API?",
  "poll": [
    { "name": "Z-API" },
    { "name": "Others" }
  ]
}
Single choice: 
{
  "phone": "5511999999999-1234567890@g.us",
  "message": "What is the best WhatsApp API?",
  "pollMaxOptions": 1,
  "poll": [
    { "name": "Z-API" },
    { "name": "Others" }
  ]
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.

​
Webhook Response

Link to the webhook response (on receive) Webhook