Skip to main content
POST
Send a list message (beta)

Authorizations

X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Body

application/json
to
string
required
text
string
required

Message body

Maximum string length: 1024
buttonText
string
required

Label of the button that opens the list

Maximum string length: 20
sections
object[]
required

Sections of the list. At most 10 rows in total across all sections, with row ids unique across the whole list.

Required array length: 1 - 10 elements
header
string

Optional header text shown above the body

Maximum string length: 60

Optional footer text shown below the body

Maximum string length: 60
aiLabel
boolean
default:false

Show WhatsApp's "AI" badge on the message. 1:1 chats only; ignored in groups.

Response

Resource created

id
string

ID of the created resource