> For the complete documentation index, see [llms.txt](https://help.pickyassist.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.pickyassist.com/api-documentation-v2/push-api/sending-carousel-message.md).

# Sending Carousel Message

Send Carousel via API

The **Carousel Message API** allows you to send interactive carousel messages directly through an API request.

### Request URL (V4)

`POST` `https://pickyassist.com/app/api/v2/push` 

This API allows you to send carousel messages to multiple numbers

### API Variable Details

<table><thead><tr><th>Variable</th><th width="115">Data Type</th><th width="258">Description</th><th>Required</th></tr></thead><tbody><tr><td><strong>token</strong></td><td>string</td><td>Unique token for the project</td><td>Mandatory</td></tr><tr><td><strong>application</strong></td><td>number</td><td><p>Specify through which application the message need to sent</p><p>121 = WhatsApp Business API<br>101 = WhatsApp Cloud API</p><p></p><p><strong>If you have connected multiple channels or using WhatsApp Cloud api then please get the channel id from your project under</strong> <a href="https://app.pickyassist.com/settings/channels"><strong>Channel</strong></a> <strong>Settings</strong></p></td><td>Mandatory</td></tr><tr><td><strong>interactive_type</strong></td><td>number</td><td>Specifies the type of interactive carousel message you want to send.<br>11 - Media Carousel<br>12 - Product Carousel</td><td>Mandatory</td></tr><tr><td><strong>globalmessage</strong></td><td>string</td><td>Message text displayed above the carousel cards in the <strong>Message Body</strong> section. With emoji supported by whatsapp. (Maximum 1024 characters)</td><td>Mandatory</td></tr><tr><td><strong>interactive</strong></td><td>Object</td><td>Contains the carousel configuration, including the list of carousel cards</td><td>Mandatory</td></tr><tr><td><strong>cards</strong></td><td>array</td><td>Contains the individual carousel cards and their media, message, and button details.</td><td></td></tr><tr><td><strong>media</strong></td><td>URL</td><td>URL from we need to fetch the <a href="https://help.pickyassist.com/setting-up-guide/setting-up-flow-builder/steps/send-carousel-message#cards">Card media</a>. Only image or video url</td><td>Mandatory</td></tr><tr><td><strong>card_message</strong></td><td>string</td><td>Specifies the message text displayed on the carousel card. (Max 160 characters, and up to 2 line breaks)</td><td>Mandatory</td></tr><tr><td><strong>buttons</strong></td><td>array</td><td>Contains the details of interactive buttons configured for the carousel card</td><td></td></tr><tr><td><strong>type</strong></td><td>numeric</td><td>Specifies the type of button.<br><strong>1</strong> = Quick Reply (max 2 per card)<br><strong>2</strong> = Url Button (only 1 button per card)</td><td>Mandatory</td></tr><tr><td><strong>title</strong></td><td>string</td><td>Specifies the text displayed on the URL/Quick Reply buttons</td><td>Mandatory</td></tr><tr><td><strong>button_id</strong></td><td>string</td><td>Specifies the identifier of the button, used to identify the button selected by the user.</td><td>Mandatory, if button type=1</td></tr><tr><td><strong>url</strong></td><td>URL</td><td>Specifies the URL opened when the button is clicked</td><td>Mandatory, if button type=2</td></tr><tr><td><strong>number</strong></td><td>numeric</td><td><p>Mobile Number with full country code <em><strong>without 0 or +</strong></em></p><p>+55 12345 6789 – Wrong Format<br><strong>55123456789 – Correct Format</strong></p></td><td>Mandatory</td></tr><tr><td><strong>product_id</strong></td><td>string</td><td>The unique ID of the product</td><td>Mandatory for Product Carousel</td></tr><tr><td><strong>data</strong></td><td>array</td><td>This is an array in which you need to pass the mobile number</td><td></td></tr></tbody></table>

### Sample Request - Media Carousel

Interactive media carousel messages display a set of horizontally scrollable media cards. Each card can display an image or video header, body text, and either quick-reply buttons or a URL button.

#### Carousel with URL button

```javascript
{
   "token":"your token",
   "application":"121",
   "interactive_type":11,
   "globalmessage":"test message body",
    "interactive":{
     	 "cards": [
    {
      "media": "media url 1",
      "card_message": "CARD MESSAGE 1",
      "buttons": [
        {
         “type”:2,
          "title": "BUTTON TITLE 1",
          "url": "BUTTON URL 1"
        }
      ]
    },
    {
      "media": "media url 2",
      "card_message": "CARD MESSAGE 2",
      "buttons": [
        {
“type”:2,
 "title": "BUTTON TITLE 2",
             "url": "BUTTON URL 2"
        }
      ]
    }

  ]

     },
   "data":[
      {
         "number":"19834434690"
      }   ]
}

```

#### Carousel with Quick Reply Button

```javascript
{
   "token":"your token",
   "application":"121",
   "interactive_type":11,
   "globalmessage":"test message body",
    "interactive": {
        "cards": [
            {
                "media": "media url 1",
                "card_message": "CARD MESSAGE 1",
                "buttons": [
                    {
                        "type": 1,
                        "title": "BUTTON TITLE 1",
                        "button_id": "QUICK REPLYBUTTON ID"
                    },
                    {
                        "type": 1,
                        "title": "BUTTON TITLE2",
                        "button_id": "QUICK REPLYBUTTON ID"
                    }
                ]
            },
            {
                "media": "media url 2",
                "card_message": "CARD MESSAGE 2",
                "buttons": [
                    {
                        "type": 1,
                        "title": "BUTTON TITLE 1",
                        "button_id": "QUICK REPLYBUTTON ID"
                    },
                    {
                        "type": 1,
                        "title": "BUTTON TITLE2",
                        "button_id": "QUICK REPLYBUTTON ID"
                    }
                ]
            }
        ]
    },
   "data":[
      {
         "number":"19834434690"
      }   ]
}

```

#### Sample Response

```javascript
{
"status":100,
"push_id":"405904770",
"message":"Success",
"data":[
{"msg_id":509099555,
"number":"919999999999",
"credit":0}
]
}
```

### Sample Request - Product Carousel

The **Product Carousel API** allows you to send multiple products from your **WhatsApp Catalog** directly to customers through an API request.

```javascript
{
   "token":"your token",
   "application":"121",
   "interactive_type":12,
   "globalmessage":"test message body",
    "interactive":{
     	 "cards": [
    {
      "product_id": "<PRODUCT_ID>"
    },
    {
      "product_id": "<PRODUCT_ID>"
        }
     ]
  }
        ]
     },
   "data":[
      {
         "number":"19834434699"
      }   ]
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.pickyassist.com/api-documentation-v2/push-api/sending-carousel-message.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.