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>.

Body

application/json
number
string
required

Recipient MSISDN or JID.

Example:

"5511999999999"

question
string
required

Poll question.

Example:

"Best day for the meeting?"

options
string[]
required

Answer options (minimum 2).

Example:
maxAnswer
integer

Maximum options a voter may select (1 = single choice).

Example:

1

id
string

Client-supplied message id.

delay
integer

Milliseconds to wait before sending.

mentionedJid
string

JID(s) to mention.

mentionAll
boolean

Mention every participant (groups).

formatJid
boolean

Auto-format number into a JID (default true).

quoted
object

Reply-to reference: { "messageId", "participant" }.

Response

Success — provider-native response body.

Standard Evolution GO send envelope (gin.H). The passthrough layer returns this native body verbatim.

message
string

Fixed status label; always "success" on HTTP 200.

data
object

Poll message send result. Serialized MessageSendStruct (no JSON tags → PascalCase keys Info/Message/MessageContextInfo).