Skip to main content
POST
Send poll

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
number
string
required

Recipient phone in E.164 without +, or a JID.

Example:

"5511999999999"

name
string
required

Poll question/title.

Example:

"Which plan do you prefer?"

selectableCount
integer
required

How many options can be selected (0–10).

Example:

1

values
string[]
required

Poll options (2–10 unique strings).

Example:
delay
integer

Delay before sending, in milliseconds.

quoted
object

Message to quote/reply to (key, message).

everyOne
boolean

Mention everyone in the group.

mentioned
string[]

Array of numeric strings to mention.

Response

Success — provider-native response body.

Sent a poll. Returns the persisted Baileys messageRaw envelope containing a pollCreationMessage.

key
object
pushName
string
status
enum<string>
Available options:
ERROR,
PENDING,
SERVER_ACK,
DELIVERY_ACK,
READ,
PLAYED
message
object
contextInfo
object | null
messageType
string
messageTimestamp
integer
instanceId
string
source
string