> For the complete documentation index, see [llms.txt](https://docs.bird.com/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bird.com/api/channels-api/message-types/list.md).

# List

{% hint style="info" %}
All examples below must be sent within the **body** field of a message as shown below
{% endhint %}

{% code lineNumbers="true" %}

```json
{
 "receiver": {
   "contacts": [
     {
       "identifierValue": "+31612345678"
     }
   ]
 },
 "body": {...}
}
```

{% endcode %}

## List message without sections

#### Body

{% code lineNumbers="true" %}

```json
{
  "type": "list",
  "list": {
    "items": [
      {
        "actions": [
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-1",
              "text": "Postback action 1"
            }
          },
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-2",
              "text": "Postback action 2"
            }
          }
        ]
      }
    ],
    "title": "List title",
    "altText": "List alt text",
    "text": "List text"
  }
}
```

{% endcode %}

#### WhatsApp

![](/files/UTKL4nvt6yKlgickpy90)

![](/files/Kziknm0iCYHBnxObR2Qb)

#### Facebook

![](/files/I6EnfygcmhF2BHaeptQX)

#### Instagram

![](/files/rsDe7XoVf6XRrsqjG6Wl)

#### Line

<div align="left"><figure><img src="/files/gvxtwoxoQdpWQtnGg7pq" alt=""><figcaption></figcaption></figure></div>

## List message with sections

#### Body

{% code lineNumbers="true" %}

```json
{
  "type": "list",
  "list": {
    "items": [
      {
      "title": "Section 1",
        "actions": [
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-1",
              "text": "Postback action 1"
            }
          },
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-2",
              "text": "Postback action 2"
            }
          }
        ]
      },
      {
        "title": "Section 2",
        "actions": [
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-3",
              "text": "Postback action 3"
            }
          },
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-4",
              "text": "Postback action 4"
            }
          }
        ]
      }
    ],
    "title": "List title",
    "altText": "List alt text",
    "text": "List text"
  }
}
```

{% endcode %}

#### WhatsApp

![](/files/PuanEogNmlccU9WlBpoM)

![](/files/zlwA3hqj77z8QIbmvv4k)

#### Facebook

![](/files/ObCJR1JGx9CSj23F8sr9)

#### Instagram

![](/files/5mhloH2Ibfrbbo8EgnNh)

## List message with metadata

#### Body

{% code lineNumbers="true" %}

```json
{
  "type": "list",
  "list": {
    "items": [
      {
        "title": "Section 1",
        "actions": [
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-1",
              "text": "Postback action 1",
              "metadata": {
                "description": {
                  "label": "Postback action description 1"
                }
              }
            }
          },
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-2",
              "text": "Postback action 2",
              "metadata": {
                "description": {
                  "label": "Postback action description 2"
                }
              }
            }
          }
        ]
      },
      {
        "title": "Section 2",
        "actions": [
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-3",
              "text": "Postback action 3",
              "metadata": {
                "description": {
                  "label": "Postback action description 3"
                }
              }
            }
          },
          {
            "type": "postback",
            "postback": {
              "payload": "postback-action-payload-4",
              "text": "Postback action 4",
              "metadata": {
                "description": {
                  "label": "Postback action description 4"
                }
              }
            }
          }
        ]
      }
    ],
    "title": "List title",
    "altText": "List alt text",
    "text": "List text",
    "metadata": {
      "button": {
        "label": "Show options"
      }
    }
  }
}
```

{% endcode %}

#### WhatsApp

![](/files/dZ89I23yDW5edFwdMZAl)

![](/files/IHE9iugvlnUDSWpf9avV)

#### Facebook

<img src="/files/ObCJR1JGx9CSj23F8sr9" alt="" data-size="original">

#### Instagram

![](/files/oTEvmz4OxBvQDgUWbrQr)
