Pular para o conteúdo principal
POST
/
instances
/
{id}
/
chat
/
send
/
poll
Enviar enquete
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": "Qual horario prefere?",
  "options": [
    "Manha",
    "Tarde",
    "Noite"
  ],
  "selectable_options_count": 1,
  "hide_participant_names": true,
  "end_time": "2026-06-20T18:00:00Z"
}
'
{
  "code": 200,
  "success": true,
  "data": {
    "message_id": "90B2F8B13FAC8A9CF6B06E99C7834DC5"
  }
}

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

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

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Corpo

application/json
phone
string
obrigatório
name
string
obrigatório

Pergunta da enquete.

options
string[]
obrigatório

Opcoes da enquete (2 a 12).

Required array length: 2 - 12 elements
selectable_options_count
integer

Quantas opcoes o destinatario pode escolher. Padrao 1 (escolha unica). Use 0 para selecao multipla sem limite.

hide_participant_names
boolean

Oculta os nomes dos votantes (equivalente ao toggle do app WhatsApp).

end_time
string<date-time>

Data/hora de termino em ISO 8601 (RFC3339) com timezone, ex. 2026-06-20T18:00:00Z. Deve ser futura. Omitir = sem prazo.

allow_add_option
boolean

Permite que participantes adicionem opcoes a enquete.

id
string

Opcional. Identificador da mensagem no pedido; se omitido, o servidor gera um automaticamente.

mentioned_ids
string[]
delay
integer
reply_to_message_id
string

ID da mensagem WhatsApp que ser? respondida/citada.

Resposta

200 - application/json

Requisicao aceita

code
integer
obrigatório
success
boolean
obrigatório
data
object