Create Carousel Template

Create a rich media carousel template. This allows you to send a horizontal scrollable view of cards, each with its own header, body, and buttons.

Example Request Body

{
    "name": "summer_carousel_sales_2024_v1",
    "language": "en",
    "category": "MARKETING",
    "components": [
        {
            "type": "BODY",
            "text": "Summer is here, and we have the freshest produce around! Use code {{1}} to get {{2}} off your next order.",
            "example": {
                "body_text": [
                    [
                        "15OFF",
                        "15%"
                    ]
                ]
            }
        },
        {
            "type": "CAROUSEL",
            "cards": [
                {
                    "components": [
                        {
                            "type": "HEADER",
                            "format": "IMAGE",
                            "example": {
                                "header_handle": [
                                    "4::aW1hZ2UvanBlZw==:ARb52CTUac8FTuSZdkoCXGdeoxDZPHtGa3LSZmQjIxGnvDhg3hJQe37IRYld6flatNuZiaa89a6M_23HGH0ylis7w1O6pILkUxR-TrLlKp-mYA:e:1708173546:256725303808337:100052252050649:ARbcwlC3kHgZ7vaMLbQ"
                                ]
                            }
                        },
                        {
                            "type": "BODY",
                            "text": "Rare lemons for unique lemon Tea. Use code {{1}} to get {{2}} off all produce.",
                            "example": {
                                "body_text": [
                                    [
                                        "LEOOFF15",
                                        "15%"
                                    ]
                                ]
                            }
                        },
                        {
                            "type": "BUTTONS",
                            "buttons": [
                                {
                                    "type": "QUICK_REPLY",
                                    "text": "Send more like this"
                                },
                                {
                                    "type": "QUICK_REPLY",
                                    "text": "need price detail"
                                }
                            ]
                        }
                    ]
                },
                {
                    "components": [
                        {
                            "type": "HEADER",
                            "format": "IMAGE",
                            "example": {
                                "header_handle": [
                                    "4::aW1hZ2UvcG5n:ARZrkzRYQS-SePQKO6o4eUFKsYqaEsuBXuuqmE8oJIFOwnrX8-cpujg_887eN0qZPntQnacOHTAZMQuC7WV4nuaJ2S5_9btVL7IJJ34k4f35PA:e:1708174367:256725303808337:100052252050649:ARaGtQPC_FWyQgaXFPk"
                                ]
                            }
                        },
                        {
                            "type": "BODY",
                            "text": "Card 2 Test body {{1}} and {{2}}",
                            "example": {
                                "body_text": [
                                    [
                                        "MELONOFF15",
                                        "15%"
                                    ]
                                ]
                            }
                        },
                        {
                            "type": "BUTTONS",
                            "buttons": [
                                {
                                    "type": "QUICK_REPLY",
                                    "text": "Send more like this"
                                },
                                {
                                    "type": "QUICK_REPLY",
                                    "text": "need price detail"
                                }
                            ]
                        }
                    ]
                },
                {
                    "components": [
                        {
                            "type": "HEADER",
                            "format": "IMAGE",
                            "example": {
                                "header_handle": [
                                    "4::aW1hZ2UvcG5n:ARY9GxwAjfNLo7lg57j3gdQFpPnvckfn4638X_6_orQcqb00wTZHyHpjzQsf1cqhRaVAqRlx9Cp-T_FvOKaOlQ5bZxBYwd-x9Z7JS9I_olarAQ:e:1708174393:256725303808337:100052252050649:ARYn0HTLnFru6DpFe9c"
                                ]
                            }
                        },
                        {
                            "type": "BODY",
                            "text": "Card 3 Test body {{1}} and {{2}}",
                            "example": {
                                "body_text": [
                                    [
                                        "APPLEOFF15",
                                        "15%"
                                    ]
                                ]
                            }
                        },
                        {
                            "type": "BUTTONS",
                            "buttons": [
                                {
                                    "type": "QUICK_REPLY",
                                    "text": "Send more like this"
                                },
                                {
                                    "type": "QUICK_REPLY",
                                    "text": "need price detail"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to v24.0
string
required
Body Params
string
string
string
enum
Allowed:
components
array of objects
components
Headers
string
required

Provide your Access Token. Format: YOUR_API_KEY

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json