Carousel

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/messages \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "CAROUSEL",
    "userId": "USER_ID",
    "text": "Check out our latest offers",
    "parameters": {
      "cards": [
        {
          "card_index": 0,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": { "link": "https://example.com/image1.png" }
          },
          "body": { "text": "Exclusive deal #1" },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "Shop now",
              "url": "https://shop.example.com/deal1"
            }
          }
        },
        {
          "card_index": 1,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": { "link": "https://example.com/image2.png" }
          },
          "body": { "text": "Exclusive deal #2" },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "Shop now",
              "url": "https://shop.example.com/deal2"
            }
          }
        }
      ]
    }
  }'

{
  "success": true,
  "messageId": "msg_123456789"
}

POST

bots

{botId}

messages

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/messages \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "CAROUSEL",
    "userId": "USER_ID",
    "text": "Check out our latest offers",
    "parameters": {
      "cards": [
        {
          "card_index": 0,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": { "link": "https://example.com/image1.png" }
          },
          "body": { "text": "Exclusive deal #1" },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "Shop now",
              "url": "https://shop.example.com/deal1"
            }
          }
        },
        {
          "card_index": 1,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": { "link": "https://example.com/image2.png" }
          },
          "body": { "text": "Exclusive deal #2" },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "Shop now",
              "url": "https://shop.example.com/deal2"
            }
          }
        }
      ]
    }
  }'

{
  "success": true,
  "messageId": "msg_123456789"
}

Available only on WhatsApp

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/messages \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "CAROUSEL",
    "userId": "USER_ID",
    "text": "Check out our latest offers",
    "parameters": {
      "cards": [
        {
          "card_index": 0,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": { "link": "https://example.com/image1.png" }
          },
          "body": { "text": "Exclusive deal #1" },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "Shop now",
              "url": "https://shop.example.com/deal1"
            }
          }
        },
        {
          "card_index": 1,
          "type": "cta_url",
          "header": {
            "type": "image",
            "image": { "link": "https://example.com/image2.png" }
          },
          "body": { "text": "Exclusive deal #2" },
          "action": {
            "name": "cta_url",
            "parameters": {
              "display_text": "Shop now",
              "url": "https://shop.example.com/deal2"
            }
          }
        }
      ]
    }
  }'

{
  "success": true,
  "messageId": "msg_123456789"
}

Path parameters

string

required

Unique identifier of the bot sending the message.

Body parameters

string

required

Message type. Must be "CAROUSEL".

string

required

Message recipient. Accepts a phone number in E.164 format without the leading + (e.g. 593999999999) or a BSUID (e.g. US.13491208655302741918) for users who have enabled phone number privacy in WhatsApp. See Identifying the recipient.

string

required

Text shown above the carousel.

object

required

Carousel content.

Show properties

object[]

required

Carousel cards. Minimum 1, maximum 10. See the card structure below.

Response

boolean

true if the message was sent successfully.

string

Identifier of the sent message.

Card structure

Field	Type	Description
`card_index`	number	Card position (zero-based).
`type`	string	Optional. Include it only when the action is `cta_url`. Omit it for cards with `quick_reply` buttons.
`header.type`	string	`image` or `video`.
`header.image.link` / `header.video.link`	string	Public URL of the header media.
`body.text`	string	Card body text.
`action`	object	Action triggered when the card is interacted with.

Card with quick reply buttons

Do not include the type field at the card level when using quick_reply buttons. It must only be set when the action is cta_url. Including it on cards with quick_reply causes Meta to reject the message with a 400/500 error.

{
  "card_index": 0,
  "header": {
    "type": "image",
    "image": { "link": "https://example.com/image.png" }
  },
  "body": { "text": "Are you interested in this offer?" },
  "action": {
    "buttons": [
      {
        "type": "quick_reply",
        "quick_reply": {
          "title": "Yes, buy",
          "payload": { "option": "buy" }
        }
      },
      {
        "type": "quick_reply",
        "quick_reply": {
          "title": "No, thanks",
          "payload": { "option": "skip" }
        }
      }
    ]
  }
}

`quick_reply` button fields

Field	Type	Description
`quick_reply.title`	string	Visible button text (max. 20 characters).
`quick_reply.payload`	object \| string	Information you receive in the webhook when the user selects the button. Useful to identify which card was chosen.
`quick_reply.id`	string	Optional. If not provided, the system generates a UUID automatically.

Restrictions

Cards: minimum 1, maximum 10 per carousel.
Header: only image or video are supported.
Compatible providers: WhatsApp Cloud API and Gupshup CAPI.

This is an interactive carousel sent inside an active WhatsApp session. It does not require an HSM template approved by Meta.

Use Cases

Product catalogs with CTA to the store
Plan or service comparisons
Multiple promotions with purchase buttons
Quick selection between options with associated image

API reference

Send Messages

Campaigns

Conversations

Tags

Metrics

Users

Resources

Widget

Datum

External Support Panel

Custom Channel

Memory Management

Path parameters

Body parameters

Response

Card structure

Card with quick reply buttons

`quick_reply` button fields

Restrictions

Use Cases

​Path parameters

​Body parameters

​Response

​Card structure

​Card with quick reply buttons

​quick_reply button fields

​Restrictions

​Use Cases

Path parameters

Body parameters

Response

Card structure

Card with quick reply buttons

`quick_reply` button fields

Restrictions

Use Cases