Send Poll
Supported & TestedCreate and send poll messages with custom options choices.
POSThttps://api.waplix.io/api/v1/messages/poll
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Waplix instance id slot |
| number | string | Required | Recipient phone number |
| question | string | Required | Poll title question text |
| options | array | Required | Array of choice options (2 to 12 strings) |
| selectable_count | number | Optional | Maximum choices selectable |
instance_id
stringReq Waplix instance id slot
number
stringReq Recipient phone number
question
stringReq Poll title question text
options
arrayReq Array of choice options (2 to 12 strings)
selectable_count
numberOpt Maximum choices selectable
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/messages/poll" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "demo_instance",
"number": "15551234567",
"name": "John Doe",
"options": [
"Yes",
"No"
]
}'Success Response
Response · 200 OK
{
"success": true,
"data": {
"instance_id": "demo_instance",
"message_id": "MSG_DEMO_001",
"question": "Hello from Waplix API docs.",
"options_count": 2,
"selectable_count": 1,
"status": "sent"
}
} Related Webhook Events
The API response confirms that Waplix accepted or processed the request. Delivery and read updates may arrive asynchronously through configured webhooks.
poll.created
Triggered when Waplix successfully creates and sends a poll message.
{
"event": "poll.created",
"instance_id": "demo_instance",
"message_id": "MSG_DEMO_001",
"question": "Hello from Waplix API docs.",
"timestamp": 1782582309
}message.deliveredDocs →
Triggered when the poll is delivered to the recipient's device.
{
"event": "message.delivered",
"instance_id": "demo_instance",
"message_id": "MSG_DEMO_001",
"chat_id": "15551234567@s.whatsapp.net",
"from": null,
"to": "15551234567@s.whatsapp.net",
"message_type": "poll",
"status": "DELIVERY_ACK",
"receipts": [],
"timestamp": 1782582310
}message.readDocs →
Triggered when the recipient reads/opens the poll message.
{
"event": "message.read",
"instance_id": "demo_instance",
"message_id": "MSG_DEMO_001",
"chat_id": "15551234567@s.whatsapp.net",
"from": null,
"to": "15551234567@s.whatsapp.net",
"message_type": "poll",
"status": "READ",
"receipts": [],
"timestamp": 1782582310
} Was this page helpful?