Skip to main content
POST
/
message
/
sendPoll
/
{instance}
Send Poll
curl --request POST \
  --url https://api.zapkey.io/message/sendPoll/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "number": "<string>",
  "pollMessage": {
    "name": "<string>",
    "selectableCount": 2,
    "values": [
      "<string>"
    ]
  },
  "options": {
    "delay": 123,
    "presence": "composing"
  }
}
'
{
  "key": {
    "remoteJid": "[email protected]",
    "fromMe": true,
    "id": "BAE53EC8D8E1FD8A"
  },
  "message": {
    "messageContextInfo": {
      "messageSecret": "lX/+cLHHNfnTTKZi+88mrhoyi6KNuUzWjgfaB0bTfOY="
    },
    "pollCreationMessage": {
      "name": "Poll Name",
      "options": [
        {
          "optionName": "Option 1"
        },
        {
          "optionName": "Option 2"
        },
        {
          "optionName": "Option 3"
        }
      ],
      "selectableOptionsCount": 1
    }
  },
  "messageTimestamp": "1717781848",
  "status": "PENDING"
}

Authorizations

​
apikey
string
header
required

Your authorization key header

Path Parameters

​
instance
string
required

ID of the instance to connect

Body

application/json
​
number
string
required

Number to receive the message (with country code)

​
pollMessage
object
required
​
options
object

Response

201 - application/json

Created

​
key
object

The key of the message, which identifies the message in the chat.

​
message
object

The message content, which may include various types of messages like text, images, poll creation, etc.

​
messageTimestamp
string

The timestamp of the message, represented as a string.

​
status
string

The status of the message, such as sent, received, or pending.