Send List

Sends a message with a list of options (menu). This is supported on WhatsApp, Z-API, and ZapperAPI channels.

​

Request Body

The API uses a dynamic schema to reconstruct sections and rows from the flat request body.

• agentId: The ID of the agent.
• conversationId: The ID of the conversation.
• header_text: (Optional) Header text (max 60 chars).
• body_text: Main message body (max 4096 chars).
• footer_text: (Optional) Footer text (max 60 chars).
• button_text: Text for the button that opens the list (max 20 chars).
• list_title: (Optional) Title for the list (mainly for Z-API).
• section_N_title: Title for section N (e.g., section_1_title).
• section_N_row_M_id: ID for row M in section N.
• section_N_row_M_title: Title for row M in section N.
• section_N_row_M_description: (Optional) Description for row M in section N.

​

Example

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "body_text": "Please choose a department:",
  "button_text": "View Departments",
  "section_1_title": "Main Services",
  "section_1_row_1_id": "row_tech",
  "section_1_row_1_title": "Technical Support",
  "section_1_row_1_description": "Hardware and software issues",
  "section_1_row_2_id": "row_billing",
  "section_1_row_2_title": "Billing",
  "section_1_row_2_description": "Invoices and payments"
}