> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Send Poll
> You can ask a question and provide a few options for the user to choose from. The user can select only one option or multiple options, depending on the poll configuration.
**V2 Queued Response:** All API requests in V2 are queued for improved reliability. You'll receive an immediate response with a `queued_request_uuid` that you can use to check the actual message status.
## Response Format
All requests return a queued response:
```json theme={null}
{
"queued": true,
"message": "Processing your request...",
"queued_request_uuid": "a0816120-7e37-4e8b-8cf3-92deb2cdc133",
"queued_request_link": "https://app.hypersender.com/api/whatsapp/v2/{instance}/queued-requests/a0816120-7e37-4e8b-8cf3-92deb2cdc133"
}
```
Use the `queued_request_link` or the [Get Queued Request](/v2/api-reference/whatsapp/queued-requests/get-queued-request) endpoint to check the actual message response once it's processed.
More details on queued requests can be found in the [Queued Requests Documentation](/v2/api-reference/whatsapp/queued-requests).
***
You can create a poll in a chat.
## OpenAPI
````yaml v2/api-reference/whatsapp/whatsapp-collection.json POST /{instance}/send-poll
openapi: 3.1.0
info:
version: v2.0
title: Hypersender WhatsApp API Docs
description: >
The Hypersender WhatsApp API is a powerful api to send and recieve messages
using your own whatsapp number.
Without the high costs of Meta's Whatsapp business API.
In this Docs you'll learn how to use and integrate Hypersnder Whatsapp API
into your existing system/service or application using simple API endpoints.
## What's New in V2?
**Queued Responses:** All requests in V2 are now queued for improved
reliability and performance. When you make a request, you'll receive an
immediate response with a `queued_request_uuid` that you can use to check
the status of your request.
**Example Response:**
```json
{
"queued": true,
"message": "Processing your request...",
"queued_request_uuid": "a0816120-7e37-4e8b-8cf3-92deb2cdc133",
"queued_request_link": "https://app.hypersender.com/api/whatsapp/v2/{instance}/queued-requests/{queued_request_uuid}"
}
```
Use the `queued_request_link` or the **Get Queued Request** endpoint to
check the actual message response once it's processed.
**What you can Do?**
- Send Text and basic Url messages.
- Send Media through Link or uploaded file.
- Send Audio through Link or uploaded file.
- Send Contact Card
- Send Location
- Send Poll votes
**You can also**
- React to a message
- Forward messages to other chats
- Acknowledge messages (mark as read)
- Star and unstar messages
**Quick Demo**
**Learn how to use Hypersender whatsapp API to send a message using Postman:**
[Demo Link](https://app.hypersender.com/send-whatsapp-message-in-postman) **to easily interact with our API.**
**postman collection**
You can download our [Postman
Collection](https://docs.hypersender.com/whatsapp-postman-collection.json)
to easily interact with our API.
## Servers (Endpoints)
- Production (activated):
[https://app.hypersender.com/api/whatsapp/v2](https://app.hypersender.com/api/whatsapp/v2)
servers:
- url: https://app.hypersender.com/api/whatsapp/v2
description: Production
security:
- Authorization: []
paths:
/{instance}/send-poll:
post:
tags:
- Send Messages
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json
examples:
default:
value: application/json
- name: Content-Type
in: header
deprecated: false
schema:
type: string
example: application/json
examples:
default:
value: application/json
- name: instance
in: path
required: true
schema:
type: string
example: '{{ instance_id }}'
examples:
default:
value: '{{ instance_id }}'
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SendPollRequest'
examples:
Example 1:
value:
chatId: 1111111111111@c.us
reply_to: string
poll:
name: How are you?
options:
- Awesome!
- Good!
- Not bad!
multipleAnswers: true
Example 2:
value:
chatId: 1111111111111@c.us
reply_to: string
poll:
name: How are you?
options:
- Awesome!
- Good!
- Not bad!
multipleAnswers: false
responses:
'201':
description: Successful response
content:
application/json:
schema:
allOf:
- type: object
properties:
id:
type: string
timestamp:
type: number
from:
type: string
fromMe:
type: boolean
body:
type: string
hasMedia:
type: boolean
media:
type: object
ack:
type: number
ackName:
type: string
replyTo:
type: string
_data:
type: object
properties:
key:
type: object
properties:
remoteJid:
type: string
fromMe:
type: boolean
id:
type: string
message:
type: object
properties:
messageContextInfo:
type: object
properties:
messageSecret:
type: string
pollCreationMessageV3:
type: object
properties:
name:
type: string
options:
type: array
items:
type: object
properties:
optionName:
type: string
selectableOptionsCount:
type: number
messageTimestamp:
type: string
status:
type: string
examples:
Example 1:
value:
id: true_11111111111@c.us_3EB0A4F993D38D3BBD04F3
timestamp: 1741448369
from: 11111111111@c.us
fromMe: true
body: null
hasMedia: false
media: null
ack: 0
ackName: PENDING
replyTo: null
_data:
key:
remoteJid: 11111111111@s.whatsapp.net
fromMe: true
id: 3EB0A4F993D38D3BBD04F3
message:
messageContextInfo:
messageSecret: VrTaj/wh+/lyIUdBi8TV4JCpbNK1Dd54SNZHH8vR2x0=
pollCreationMessageV3:
name: Sample Poll
options:
- optionName: Option 1
- optionName: Option 2
- optionName: Option 3
selectableOptionsCount: 1
messageTimestamp: 1741448369
status: PENDING
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
security:
- Authorization: []
components:
schemas:
SendPollRequest:
type: object
properties:
chatId:
type: string
example: 1111111111111@c.us
reply_to:
type: string
poll:
type: object
properties:
name:
type: string
options:
type: array
items:
type: string
multipleAnswers:
type: boolean
required:
- chatId
- poll
ValidationError:
type: object
title: ValidationError
properties:
message:
type: string
errors:
type: object
description: Invalid or missing feilds will be shown here
statusCode:
type: number
example:
message: The given data was invalid.
errors: {}
statusCode: 422
required:
- errors
- statusCode
x-examples:
Multiple fields Error:
message: The given data was invalid.
errors:
messages:
- The number you want to send the message to is not on whatsapp.
jid: 20121323124131@s.whatsapp.net
exists: false
statusCode: 422
'Single Field error ':
message: The given data was invalid.
errors:
messages:
- textMessage.text should not be empty
statusCode: 422
x-stoplight:
id: 90x3wfxw7gqcb
ServerError:
type: object
title: ServerError
properties:
message:
type: string
example:
message: Internal Server Error
x-stoplight:
id: 2fhq2gihsfreh
securitySchemes:
Authorization:
type: http
scheme: bearer
````