flow api
Sending · POST

sendListMessage

Send a tap-to-choose menu: a button that opens a list of up to 10 options, grouped in sections. Requires Interactive menus (Beta) on the number.

Video walkthrough: sendListMessage · 20 seconds · click the bar to jump to a step

Endpoint

POST https://flowapi.pro/waInstance{idInstance}/sendListMessage/{apiTokenInstance}

Request body

{
  "chatId": "972501234567@c.us",
  "message": "Pick a delivery time",
  "title": "Delivery",
  "footer": "",
  "buttonText": "Choose",
  "sections": [
    {
      "title": "Tomorrow",
      "rows": [
        {
          "rowId": "am",
          "title": "Morning",
          "description": "8:00–12:00"
        },
        {
          "rowId": "pm",
          "title": "Afternoon",
          "description": "12:00–17:00"
        }
      ]
    }
  ]
}

Example

curl -X POST "https://flowapi.pro/waInstance{idInstance}/sendListMessage/{apiTokenInstance}" \
  -H "Content-Type: application/json" \
  -d '{"chatId":"972501234567@c.us","message":"Pick a delivery time","title":"Delivery","footer":"","buttonText":"Choose","sections":[{"title":"Tomorrow","rows":[{"rowId":"am","title":"Morning","description":"8:00–12:00"},{"rowId":"pm","title":"Afternoon","description":"12:00–17:00"}]}]}'

Response

{
  "idMessage": "3EB0…"
}

Notes

  • Body: chatId, message, title, footer, buttonText, sections [{ title, rows [{ rowId, title, description }] }].
  • A choice arrives as incomingMessageReceived with typeMessage listResponseMessage: rowId, title, stanzaId (the menu message).
  • Option titles are limited to 24 characters; the button text to 20.
Green API compatible. sendListMessage uses the same name, request body and response as Green API, so existing code works after you change the host to flowapi.pro. Errors: 401 wrong instance or token, 402 trial ended or number not covered by your plan, 429 rate limit reached (wait the seconds in the Retry-After header), 400 with a message for anything else.

More sending methods

Try it on your own number

7 days free, no credit card. Then $10 per number per month.

Start free trial