Send List

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

Authentication: Requires a valid API key or session. Pass as Authorization: Bearer <api_key>.

​

Request Body

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

​

Required Parameters

• agentId: The ID of the agent.
• conversationId: The ID of the conversation.
• body_text: Main message body (max 4096 chars).
• button_text: Text for the button that opens the list (max 20 chars).
• section_1_title: Title for section 1.
• section_1_row_1_id: ID for row 1 in section 1.
• section_1_row_1_title: Title for row 1 in section 1.

​

Optional Parameters

• header_text: Header text (max 60 chars).
• footer_text: Footer text (max 60 chars).
• list_title: Title for the list (mainly used for Z-API).
• section_2_title, section_3_title, etc.: Additional sections (max 10).
• section_N_row_M_id, section_N_row_M_title, section_N_row_M_description: Additional rows (max 10 rows total across all sections).

​

Limits (Meta)

• Maximum 10 sections.
• Maximum 10 rows total across all sections.
• Button text: max 20 characters.
• Header text: max 60 characters.
• Footer text: max 60 characters.
• Body text: max 4096 characters.

​

Example

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "header_text": "Select a department",
  "body_text": "Please choose a department:",
  "footer_text": "We typically respond within 1 hour",
  "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"
}

​

Error Responses