POST
/
message
/
sendList
/
{instance}
curl --request POST \
  --url https://{server-url}/message/sendList/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "number": "<string>",
  "options": {
    "delay": 123,
    "presence": "composing"
  },
  "listMessage": {
    "title": "<string>",
    "description": "<string>",
    "buttonText": "<string>",
    "footerText": "<string>",
    "sections": [
      {
        "title": "<string>",
        "rows": [
          {
            "title": "<string>",
            "description": "<string>",
            "rowId": "<string>"
          }
        ]
      }
    ]
  }
}'
{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE5096096C5E261"
  },
  "message": {
    "listMessage": {
      "title": "List Title",
      "description": "List description",
      "buttonText": "Click Me",
      "listType": "PRODUCT_LIST",
      "sections": [
        {
          "title": "Section title",
          "rows": [
            {
              "title": "Row 1",
              "description": "Row 1 description",
              "rowId": "1"
            },
            {
              "title": "Row 2",
              "description": "Row 2 description",
              "rowId": "2"
            }
          ]
        },
        {
          "title": "Section 2",
          "rows": [
            {
              "title": "Row 1",
              "description": "Row 1 description",
              "rowId": "1"
            },
            {
              "title": "Row 2",
              "description": "Row 2 description",
              "rowId": "2"
            }
          ]
        }
      ],
      "contextInfo": {}
    }
  },
  "messageTimestamp": "1717782429",
  "status": "PENDING"
}

Authorizations

​
apikey
string
header
required

Your authorization key header

Path Parameters

​
instance
string
required

ID of the instance to connect

Body

application/json
​
number
string

Number to receive the message (with country code)

​
options
object
​
listMessage
object

Response

201 - application/json
Created
​
message
object
required

The message content, which may include various types of messages like text, images, list, etc.

​
key
object

The key of the message, which identifies the message in the chat.

​
messageTimestamp
string

The timestamp of the message, represented as a string.

​
status
string

The status of the message, such as sent, received, or pending.