Skip to main content
POST
/
instances
/
{id}
/
chat
/
send
/
poll
Send poll
curl --request POST \
  --url https://api.vzaps.com/instances/{id}/chat/send/poll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "name": "Which time do you prefer?",
  "options": [
    "Morning",
    "Afternoon",
    "Evening"
  ],
  "selectable_options_count": 1,
  "hide_participant_names": true,
  "end_time": "2026-06-20T18:00:00Z"
}
'
{
  "code": 200,
  "success": true,
  "data": {
    "message_id": "90B2F8B13FAC8A9CF6B06E99C7834DC5"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Example:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Body

application/json
phone
string
required
name
string
required

Poll question.

options
string[]
required

Poll options (2 to 12).

Required array length: 2 - 12 elements
selectable_options_count
integer

How many options the recipient may select. Default 1 (single choice). Use 0 for unlimited multiple selection.

hide_participant_names
boolean

Hide voter names (same as the WhatsApp app toggle).

end_time
string<date-time>

End datetime in ISO 8601 (RFC3339) with timezone, e.g. 2026-06-20T18:00:00Z. Must be in the future. Omit for no deadline.

allow_add_option
boolean

Allow participants to add options to the poll.

id
string

Optional. Message identifier for the request; if omitted, the server generates one automatically.

mentioned_ids
string[]
delay
integer
reply_to_message_id
string

WhatsApp message ID to reply to or quote.

Response

200 - application/json

Request accepted

code
integer
required
success
boolean
required
data
object