Skip to main content
POST
Send list

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"

title
string
required

List title.

Example:

"Our menu"

Footer text shown below the list.

Example:

"Pilot Status"

buttonText
string
required

Label of the button that opens the list.

Example:

"View options"

sections
object[]
required

Array of section objects (see fields below).

Example:
sections[].title
string
required

Section title.

sections[].rows
object[]
required

Rows, each with title, rowId (required) and optional description.

description
string

List description/body text.

Example:

"Pick an item"

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 an interactive list message. Returns the persisted Baileys messageRaw envelope containing a listMessage.

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