Send list
Sends an interactive list message with sections and selectable rows.
curl --request POST \
--url https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"number": "5511999999999",
"title": "Our menu",
"footerText": "Pilot Status",
"buttonText": "View options",
"sections": [
{
"title": "Drinks",
"rows": [
{
"title": "Coffee",
"description": "Fresh brewed",
"rowId": "drink_coffee"
},
{
"title": "Tea",
"description": "Green tea",
"rowId": "drink_tea"
}
]
}
],
"sections[].title": "<string>",
"sections[].rows": [
{}
],
"description": "Pick an item",
"delay": 123,
"quoted": {},
"everyOne": true,
"mentioned": [
"<string>"
]
}
'import requests
url = "https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}"
payload = {
"number": "5511999999999",
"title": "Our menu",
"footerText": "Pilot Status",
"buttonText": "View options",
"sections": [
{
"title": "Drinks",
"rows": [
{
"title": "Coffee",
"description": "Fresh brewed",
"rowId": "drink_coffee"
},
{
"title": "Tea",
"description": "Green tea",
"rowId": "drink_tea"
}
]
}
],
"sections[].title": "<string>",
"sections[].rows": [{}],
"description": "Pick an item",
"delay": 123,
"quoted": {},
"everyOne": True,
"mentioned": ["<string>"]
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '5511999999999',
title: 'Our menu',
footerText: 'Pilot Status',
buttonText: 'View options',
sections: [
{
title: 'Drinks',
rows: [
{title: 'Coffee', description: 'Fresh brewed', rowId: 'drink_coffee'},
{title: 'Tea', description: 'Green tea', rowId: 'drink_tea'}
]
}
],
'sections[].title': '<string>',
'sections[].rows': [{}],
description: 'Pick an item',
delay: 123,
quoted: {},
everyOne: true,
mentioned: ['<string>']
})
};
fetch('https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'number' => '5511999999999',
'title' => 'Our menu',
'footerText' => 'Pilot Status',
'buttonText' => 'View options',
'sections' => [
[
'title' => 'Drinks',
'rows' => [
[
'title' => 'Coffee',
'description' => 'Fresh brewed',
'rowId' => 'drink_coffee'
],
[
'title' => 'Tea',
'description' => 'Green tea',
'rowId' => 'drink_tea'
]
]
]
],
'sections[].title' => '<string>',
'sections[].rows' => [
[
]
],
'description' => 'Pick an item',
'delay' => 123,
'quoted' => [
],
'everyOne' => true,
'mentioned' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"title\": \"Our menu\",\n \"footerText\": \"Pilot Status\",\n \"buttonText\": \"View options\",\n \"sections\": [\n {\n \"title\": \"Drinks\",\n \"rows\": [\n {\n \"title\": \"Coffee\",\n \"description\": \"Fresh brewed\",\n \"rowId\": \"drink_coffee\"\n },\n {\n \"title\": \"Tea\",\n \"description\": \"Green tea\",\n \"rowId\": \"drink_tea\"\n }\n ]\n }\n ],\n \"sections[].title\": \"<string>\",\n \"sections[].rows\": [\n {}\n ],\n \"description\": \"Pick an item\",\n \"delay\": 123,\n \"quoted\": {},\n \"everyOne\": true,\n \"mentioned\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"title\": \"Our menu\",\n \"footerText\": \"Pilot Status\",\n \"buttonText\": \"View options\",\n \"sections\": [\n {\n \"title\": \"Drinks\",\n \"rows\": [\n {\n \"title\": \"Coffee\",\n \"description\": \"Fresh brewed\",\n \"rowId\": \"drink_coffee\"\n },\n {\n \"title\": \"Tea\",\n \"description\": \"Green tea\",\n \"rowId\": \"drink_tea\"\n }\n ]\n }\n ],\n \"sections[].title\": \"<string>\",\n \"sections[].rows\": [\n {}\n ],\n \"description\": \"Pick an item\",\n \"delay\": 123,\n \"quoted\": {},\n \"everyOne\": true,\n \"mentioned\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"title\": \"Our menu\",\n \"footerText\": \"Pilot Status\",\n \"buttonText\": \"View options\",\n \"sections\": [\n {\n \"title\": \"Drinks\",\n \"rows\": [\n {\n \"title\": \"Coffee\",\n \"description\": \"Fresh brewed\",\n \"rowId\": \"drink_coffee\"\n },\n {\n \"title\": \"Tea\",\n \"description\": \"Green tea\",\n \"rowId\": \"drink_tea\"\n }\n ]\n }\n ],\n \"sections[].title\": \"<string>\",\n \"sections[].rows\": [\n {}\n ],\n \"description\": \"Pick an item\",\n \"delay\": 123,\n \"quoted\": {},\n \"everyOne\": true,\n \"mentioned\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"key": {
"remoteJid": "5511999999999@s.whatsapp.net",
"fromMe": true,
"id": "3EB0LIST778899AABBCCDD"
},
"pushName": "Você",
"status": "PENDING",
"message": {
"listMessage": {
"title": "Cardápio",
"description": "Escolha uma opção",
"buttonText": "Ver opções",
"footerText": "Pilot Status",
"listType": "SINGLE_SELECT",
"sections": [
{
"title": "Lanches",
"rows": [
{
"title": "X-Burguer",
"description": "Pão, carne e queijo",
"rowId": "item_1"
},
{
"title": "X-Salada",
"description": "Com alface e tomate",
"rowId": "item_2"
}
]
}
]
}
},
"contextInfo": null,
"messageType": "listMessage",
"messageTimestamp": 1720483800,
"instanceId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"source": "web"
}{
"status": 400,
"error": "Bad Request",
"message": "Invalid payload"
}Authorizations
Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.
Path Parameters
The number's display name in the Pilot Status dashboard.
Body
Recipient phone in E.164 without +, or a JID.
"5511999999999"
List title.
"Our menu"
Footer text shown below the list.
"Pilot Status"
Label of the button that opens the list.
"View options"
Array of section objects (see fields below).
[
{
"title": "Drinks",
"rows": [
{
"title": "Coffee",
"description": "Fresh brewed",
"rowId": "drink_coffee"
},
{
"title": "Tea",
"description": "Green tea",
"rowId": "drink_tea"
}
]
}
]
Section title.
Rows, each with title, rowId (required) and optional description.
List description/body text.
"Pick an item"
Delay before sending, in milliseconds.
Message to quote/reply to (key, message).
Mention everyone in the group.
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.
Was this page helpful?
curl --request POST \
--url https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"number": "5511999999999",
"title": "Our menu",
"footerText": "Pilot Status",
"buttonText": "View options",
"sections": [
{
"title": "Drinks",
"rows": [
{
"title": "Coffee",
"description": "Fresh brewed",
"rowId": "drink_coffee"
},
{
"title": "Tea",
"description": "Green tea",
"rowId": "drink_tea"
}
]
}
],
"sections[].title": "<string>",
"sections[].rows": [
{}
],
"description": "Pick an item",
"delay": 123,
"quoted": {},
"everyOne": true,
"mentioned": [
"<string>"
]
}
'import requests
url = "https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}"
payload = {
"number": "5511999999999",
"title": "Our menu",
"footerText": "Pilot Status",
"buttonText": "View options",
"sections": [
{
"title": "Drinks",
"rows": [
{
"title": "Coffee",
"description": "Fresh brewed",
"rowId": "drink_coffee"
},
{
"title": "Tea",
"description": "Green tea",
"rowId": "drink_tea"
}
]
}
],
"sections[].title": "<string>",
"sections[].rows": [{}],
"description": "Pick an item",
"delay": 123,
"quoted": {},
"everyOne": True,
"mentioned": ["<string>"]
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '5511999999999',
title: 'Our menu',
footerText: 'Pilot Status',
buttonText: 'View options',
sections: [
{
title: 'Drinks',
rows: [
{title: 'Coffee', description: 'Fresh brewed', rowId: 'drink_coffee'},
{title: 'Tea', description: 'Green tea', rowId: 'drink_tea'}
]
}
],
'sections[].title': '<string>',
'sections[].rows': [{}],
description: 'Pick an item',
delay: 123,
quoted: {},
everyOne: true,
mentioned: ['<string>']
})
};
fetch('https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'number' => '5511999999999',
'title' => 'Our menu',
'footerText' => 'Pilot Status',
'buttonText' => 'View options',
'sections' => [
[
'title' => 'Drinks',
'rows' => [
[
'title' => 'Coffee',
'description' => 'Fresh brewed',
'rowId' => 'drink_coffee'
],
[
'title' => 'Tea',
'description' => 'Green tea',
'rowId' => 'drink_tea'
]
]
]
],
'sections[].title' => '<string>',
'sections[].rows' => [
[
]
],
'description' => 'Pick an item',
'delay' => 123,
'quoted' => [
],
'everyOne' => true,
'mentioned' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"title\": \"Our menu\",\n \"footerText\": \"Pilot Status\",\n \"buttonText\": \"View options\",\n \"sections\": [\n {\n \"title\": \"Drinks\",\n \"rows\": [\n {\n \"title\": \"Coffee\",\n \"description\": \"Fresh brewed\",\n \"rowId\": \"drink_coffee\"\n },\n {\n \"title\": \"Tea\",\n \"description\": \"Green tea\",\n \"rowId\": \"drink_tea\"\n }\n ]\n }\n ],\n \"sections[].title\": \"<string>\",\n \"sections[].rows\": [\n {}\n ],\n \"description\": \"Pick an item\",\n \"delay\": 123,\n \"quoted\": {},\n \"everyOne\": true,\n \"mentioned\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"title\": \"Our menu\",\n \"footerText\": \"Pilot Status\",\n \"buttonText\": \"View options\",\n \"sections\": [\n {\n \"title\": \"Drinks\",\n \"rows\": [\n {\n \"title\": \"Coffee\",\n \"description\": \"Fresh brewed\",\n \"rowId\": \"drink_coffee\"\n },\n {\n \"title\": \"Tea\",\n \"description\": \"Green tea\",\n \"rowId\": \"drink_tea\"\n }\n ]\n }\n ],\n \"sections[].title\": \"<string>\",\n \"sections[].rows\": [\n {}\n ],\n \"description\": \"Pick an item\",\n \"delay\": 123,\n \"quoted\": {},\n \"everyOne\": true,\n \"mentioned\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/evolution-v2/message/sendList/{instance}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"title\": \"Our menu\",\n \"footerText\": \"Pilot Status\",\n \"buttonText\": \"View options\",\n \"sections\": [\n {\n \"title\": \"Drinks\",\n \"rows\": [\n {\n \"title\": \"Coffee\",\n \"description\": \"Fresh brewed\",\n \"rowId\": \"drink_coffee\"\n },\n {\n \"title\": \"Tea\",\n \"description\": \"Green tea\",\n \"rowId\": \"drink_tea\"\n }\n ]\n }\n ],\n \"sections[].title\": \"<string>\",\n \"sections[].rows\": [\n {}\n ],\n \"description\": \"Pick an item\",\n \"delay\": 123,\n \"quoted\": {},\n \"everyOne\": true,\n \"mentioned\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"key": {
"remoteJid": "5511999999999@s.whatsapp.net",
"fromMe": true,
"id": "3EB0LIST778899AABBCCDD"
},
"pushName": "Você",
"status": "PENDING",
"message": {
"listMessage": {
"title": "Cardápio",
"description": "Escolha uma opção",
"buttonText": "Ver opções",
"footerText": "Pilot Status",
"listType": "SINGLE_SELECT",
"sections": [
{
"title": "Lanches",
"rows": [
{
"title": "X-Burguer",
"description": "Pão, carne e queijo",
"rowId": "item_1"
},
{
"title": "X-Salada",
"description": "Com alface e tomate",
"rowId": "item_2"
}
]
}
]
}
},
"contextInfo": null,
"messageType": "listMessage",
"messageTimestamp": 1720483800,
"instanceId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"source": "web"
}{
"status": 400,
"error": "Bad Request",
"message": "Invalid payload"
}