Actions396
- Kanban Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Message Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Queue Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Schedule Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Scheduled Message Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- SMS Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Tag Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Ticket Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Validation Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- WABA Template Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
- Wallet Actions
- Cancel Schedule
- Cancel Scheduled Message
- Close Ticket
- Create Schedule
- Create Tag
- Generate Calendar Link (.ics)
- Link Kanban
- Link Tag
- Link Wallet
- List Agents
- List Available Slots
- List Available Users
- List Kanbans
- List Queues
- List Scheduled Messages (Typebot)
- List Schedules
- List Services
- List Tags
- List WABA Templates
- List Wallets
- Next Assignee in Queue
- Schedule Message (Typebot)
- Send Base64 File
- Send Buttons
- Send Carousel
- Send List
- Send Media With Caption
- Send Message
- Send Short SMS
- Send WABA Template
- Transfer to Agent
- Transfer to Next Assignee
- Transfer to Queue
- Validate CPF
- Validate Date
- Validate WhatsApp
SMS → Send List
AI-generatedSummary
Send an interactive WhatsApp list message to a specified phone number.
Inputs
- param (required) — Connection UUID parameter required by the operation (in this case, used as connection identification).
- externalKey — Optional unique identifier for the message to help with message tracking.
- listTitle (required) — Title displayed at the top of the list.
- listText (required) — Descriptive text prompting the recipient to pick a category or option.
- listButtonText (required) — Text label for the button that triggers showing the list.
- listFooter (required) — Footer text displayed at the bottom of the list.
- listPhoneNumber (required) — Recipient phone number with country and area code format (e.g., 5511999999999).
- sectionsData (required) — JSON array representing the list's sections, each with a title and an array of lines containing item titles, descriptions, and row IDs.
Output shape
a single JSON object representing the API response for the send list message operation
Requires a valid connection UUID in 'param' to identify the WhatsApp connection. The 'sectionsData' must be valid JSON; invalid JSON will cause an error. Optional 'externalKey' can be used for tracking. The output object varies depending on the API response but will be provided as JSON.
Examples
Example 1: Send a WhatsApp list message with options to a customer
Set 'param' with the WhatsApp connection UUID, define 'listPhoneNumber' for the recipient, 'listTitle' for the menu heading, 'listText' for instructions, 'listButtonText' for the trigger button text, 'listFooter' for footer text, and provide 'sectionsData' as JSON outlining the menu options and categories.