Actions90
- Sessions Actions
- Messages - Sending Actions
- Chats Actions
- Messages - Actions Actions
- Groups Actions
- List Groups
- Group Info
- Get Invite Link
- Revoke Invite Link
- Join via Link
- Preview via Link
- Create Group
- Delete Group
- Update Group Description
- Toggle Announcement Mode
- List Participants
- Add Participants
- Remove Participants
- Demote Participants
- Approve Join Request
- Reject Join Request
- List Join Requests
- Get Group Picture
- Set Group Picture
- Delete Group Picture
- Leave Group
- Update Group Name
- Lock Group Edits
- Promote Participants
- Profile Actions
- Server Actions
- Miscellaneous Actions
Overview
This node operation sends a list message via the WARest WhatsApp REST API. It allows users to send interactive list messages to specified recipients within a chosen WhatsApp session. This is useful for scenarios where you want to present recipients with a structured list of options to choose from, such as menus, catalogs, or categorized selections.
Use Case Examples
- Sending a product catalog as a list message to customers.
- Providing a menu of service options in a customer support chat.
- Sharing a categorized list of events or choices in a group chat.
Properties
| Name | Meaning |
|---|---|
| Session | The WhatsApp session from which the list message will be sent. It can be selected from existing sessions or entered manually. |
| Recipient / Chat (to) | The phone number or JID of the recipient(s) to whom the list message will be sent. Can be a single or comma-separated list. |
| Body Message | The main message text displayed above the list buttons. |
| Footer | Optional footer text displayed below the list message. |
| Image (URL/Data) | Optional header image URL or base64 data to display at the top of the list message. |
| Button Text | The text shown on the button that reveals the list sections. |
| Sections | The sections of the list, each containing a title and multiple rows. Each row has an ID, title, optional description, and optional header. |
| Additional Fields | Optional additional message fields such as presence indicator (typing/recording), reply to a specific message ID, and marking the message as forwarded. |
Output
JSON
json- The JSON response from the WARest API containing the result of the send list message operation.
Dependencies
- Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.
Troubleshooting
- Ensure the session ID is valid and active; invalid or expired sessions will cause errors.
- Verify the recipient phone number or JID format is correct and reachable via WhatsApp.
- Make sure at least one section with one row is added to the list; empty lists will throw an error.
- If using an image URL or data, ensure it is accessible and correctly formatted.
- Check that the button text and body message are not empty, as they are required fields.
Links
- WARest API - Send List Message - Official documentation for sending list messages using the WARest WhatsApp REST API.