Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Actions51

Message → Send Option List

AI-generated

Summary

Send an option list message to a phone number

Inputs

  • phone (required) — Contact number (or group ID) in international format, digits only.
  • message (required) — Message text to be sent
  • delayMessage — Delay in seconds before sending the message (1‑15).
  • optionListTitle (required) — Listing title for the option list.
  • optionListButtonLabel (required) — Button label that opens the option list.
  • optionListOptions (required) — List of selectable options (each with title, description, optional ID).

Output shape

object containing the raw JSON response from Z-API (typically a success indicator and any payload)

Response varies by API; no standardized envelope; treat as opaque.

Examples

Example 1: Prompt a customer to choose a service

phone: 5511999999999, message: 'Select a service', optionListTitle: 'Services', optionListButtonLabel: 'Select', optionListOptions: [{title:'Billing',description:'View billing',id:'billing'},{title:'Support',description:'Contact support',id:'support'}]

Example 2: Ask a user to confirm an appointment

phone: 5511999999999, message: 'Confirm appointment?', optionListTitle: 'Confirm', optionListButtonLabel: 'Confirm', optionListOptions: [{title:'Yes',description:'Yes, confirm',id:'yes'},{title:'No',description:'Cancel',id:'no'}]

Example 3: Provide quick links to help articles

phone: 5511999999999, message: 'Choose a help article', optionListTitle: 'Help Topics', optionListButtonLabel: 'Open', optionListOptions: [{title:'Billing',description:'Billing FAQ',id:'billing'},{title:'Technical',description:'Technical support',id:'tech'}]

Links

Discussion