LogoLogo
Become a PartnerStatus Page
  • get started
    • Welcome to 360Dialog
    • Quickstarts
      • Register as a Meta Tech Provider
      • Add a WhatsApp Number
      • Set up Integrated Onboarding
      • Create a Message Template
      • Send a Message
      • (temp title) Getting started as a partner
    • Pricing & Billing
      • Payment Methods for BR: Pix & Boleto
      • Month Closing Invoice (MCI)
    • Get API Access
    • Tech Provider Program
      • Understanding the Meta Tech Provider Program
      • Becoming a Meta Tech Provider: A Step-by-Step Guide
  • MM Lite Beta Program
    • Onboarding
    • Sending Messages
    • Expected Errors & Programming Languages
    • MM Lite Sandbox Testing
      • Sending Messages using MM Lite Sandbox
      • Expected Erros & Programming Languages
  • Partner & Account Management
    • Solutions for Partners
      • Benefits for Partners
      • Partner Hub
      • WABA Management
    • Account Setup & Management
      • Prerequisites and best practices for account creation
      • Account Structure
      • Account Creation
  • Integrations & API Development
    • Webhook Events & Setup
      • Webhook Events (Partner & Messaging API)
      • Webhook Configuration & Management
    • Integration Best Practices
      • Architecture and Security
      • Best Practices for Designing Integrations
        • Design a Stable Webhook Receiving Endpoint
      • Sizing Your Environment Based on Expected Throughput
      • Design a Resilient Message Sending Service
      • Integrated Onboarding
        • Basic Integrated Onboarding
        • Custom Integrated Onboarding
        • Host Your Own Embedded Signup
      • API Key Authentication for the Partner API
  • API Reference
    • Messaging API
    • Messaging Health Status
    • Sandbox (Test API Key)
    • Differences Between Cloud API and On-Premise API for Partners
      • [will be deprecated] Messaging with On-Premise API
    • Partner API
  • WABA Management
    • Managing WABA Accounts
      • Using the Partner Hub to manage Clients and Channels
      • Using the Partner API to manage Clients and Channels
      • Partner Permission to Generate API Key
      • Checking Usage & Statistics
    • Phone Number & Hosting
      • Migrating a Phone Number
        • Migrate number from Meta or alternate BSP to 360Dialog
        • Migrate a phone number to a new WABA
        • Migrate a phone number to a new WABA to change messaging Currency
      • WhatsApp Coexistence
        • Coexistence Onboarding
        • Coexistence Webhooks
      • Hosting type Change (On-premise API to Cloud API)
    • WABA Profile & Compliance
      • Display Name Guidelines
      • WABA Profile Info
      • WABA Policy Enforcement
      • Business Account Verification
    • Partner change (between 360Dialog Partners)
    • WhatsApp Flows
    • Accelerated Onboarding
    • Business Account Verification
  • Messaging
    • Sending & Receiving Messages
      • Conversations
      • Receiving messages
      • Before sending a message
    • Message Types
      • Conversational Components
      • Checklist for Message Broadcasts and Campaigns
      • Text messages
      • Interactive messages
        • Single and Multi Product Messages
        • Location Request Messages
        • Address Messages (India and Singapore only)
      • Contacts & Location Messages
    • Template Messages
      • Template Library
      • Template Elements
      • Sending Template Messages
      • Authentication Templates
        • Zero-Tap Authentication Templates
        • One-Tap Autofill Authentication Templates
        • Copy Code Authentication Templates
      • Catalog Templates
      • Product Card Carousel Templates
      • Single-Product Message Templates
      • Coupon Code Templates
      • Limited-Time Offer Templates
      • Multi-Product Templates
    • Media Messages
      • Upload, retrieve or delete media
    • Messaging Health & Troubleshooting
      • Messaging Limits & Quality Rating
      • Errors While Messaging
      • Messages statuses
  • Commerce & Payments
    • Payments (India Only)
      • Receive WhatsApp Payments via Payments Gateway
      • Receive WhatsApp Payments via Payment Links
      • Order Details Template Message
    • Payments (Singapore Only)
      • Receive WhatsApp Payments via Stripe
    • Products and Catalogs
      • India Businesses: Compliance for Commerce
  • Support & Updates
    • Help & Troubleshooting
      • FAQ
      • Error Code Reference
      • User Support Documentation
        • Tutorials
          • Page How to Troubleshoot Login Issues in the 360dialog Hub
          • How to Report an Issue
          • How to Contact Support
        • How-To Guides
          • Raise a support request
          • Requesting a Status Update for Business Verification
        • Reference
          • Troubleshooting Embedded Signup Issues
          • Commerce Policy Checks for WhatsApp API Access
          • Support Availability & SLAs
          • Incident Issue Prioritization
          • Case Types Table
        • Explanation
          • Why Business Verification Takes Time
          • Why Some Issues Are Not Emergencies
          • Understanding the Support Process
      • Support with Meta
    • Imprint & Data Privacy
    • Product Updates & News
      • How to ensure your Template Messages will be received
      • Integrated Onboarding new look and Campaigns Best Practices
Powered by GitBook
On this page
  • Creating Product Card Carousel Templates
  • Sending Product Card Carousel Templates

Was this helpful?

  1. Messaging
  2. Template Messages

Product Card Carousel Templates

PreviousCatalog TemplatesNextSingle-Product Message Templates

Last updated 7 months ago

Was this helpful?

Product Card Carousel Templates are only available while using Cloud API.

Product Card Carousel templates allow you to send a single text message (1), accompanied by a set of up to 10 carousel cards (2) in a horizontally scrollable view.

From January 2024, in addition to the mobile device experience, users can now view Carousel messages seamlessly on the WhatsApp Web Client.

SPM (View Button)

You can add the SPM button to your Product Card Carousel Template and users can tap it to see details about the product, and can add or remove the product from the WhatsApp shopping cart.

URL Buttons

Instead of View buttons you may wish to use URL buttons. When a WhatsApp user taps a URL button to buy a product, the URL is loaded in the device's default web browser, taking the user out of the WhatsApp client experience. This can be useful if, for example, you wish to load the product in your checkout page where users can add promo codes and find related products.

Carousel Cards

The media header format and buttons must be the same across all cards that make up a carousel template. Media assets will be cropped to a wide ratio based on the customer's device.

Catalogs

Webhooks

Creating Product Card Carousel Templates

Use the create template endpoint to create Product Card Carousel Template.

POST https://waba-v2.360dialog.io/v1/configs/templates

Headers

Name
Type
Description

D360-API-KEY

string

Once your template is approved, you can send it in a template message.

Post Body

It is only necessary to define two product cards upon template creation. An approved template with two product cards can be used to send up to 10 cards in a template message.

{
  "name": "<TEMPLATE_NAME>",
  "language": "<TEMPLATE_LANGUAGE>",
  "category": "marketing",
  "components": [
    {
      "type": "body",
      "text": "<MESSAGE_BODY_TEXT>",
      "example": {
        "body_text": [
          [
            "<MESSAGE_BODY_TEXT_VARIABLE_EXAMPLE>",
            "<MESSAGE_BODY_TEXT_VARIABLE_EXAMPLE>"
          ]
        ]
      }
    },
    {
      "type": "carousel",
      "cards": [

        /* First product card */
        {
          "components": [
            {
              "type": "header",
              "format": "product"
            },

            /* Supports 1 button only, can be either an SPM button or URL button */
            {
              "type": "buttons",
              "buttons": [

                /* SPM button */
                {
                  "type": "spm",
                  "text": "View"
                }

                /* URL button */
                {
                  "type": "url",
                  "text": "<URL_BUTTON_LABEL_TEXT>",
                  "url": "<URL_BUTTON_URL>",
                  "example": [
                    "<URL_BUTTON_URL_VARIABLE_EXAMPLE>"
                  ]
                }

              ]
            }
          ]
        },
     
        /* Second product card would follow, using same structure as
           first card. It is only necessary to define two cards. */

      ]
    }
  ]
}

Properties

Placeholder
Description
Example Value

<MESSAGE_BODY_TEXT>

String

Required.

Message bubble text string. Supports variables.

Maximum 1024 characters.

Summer is here, and we've got the freshest produce around! Use code {{1}} to get {{2}} off your next order.

<MESSAGE_BODY_TEXT_VARIABLE_EXAMPLE>

String

Required if the message body text string uses variables.

Message body text example variable string(s).

Number of strings must match the number of variable placeholders in the message body text string.

If message body text uses a single variable, body_text value can be a string, otherwise it must be an array containing an array of strings.

"15OFF","15%"

<TEMPLATE_LANGUAGE>

Enum

Required.

en_US

<TEMPLATE_NAME>

String

Required.

Template name.

Maximum 512 characters.

summer_carousel_promo_2023

<URL_BUTTON_LABEL_TEXT>

String

Required if using a URL button.

25 characters maximum.

Buy now

<URL_BUTTON_URL>

String

Required if using a URL button.

Supports 1 variable, appended to the end of the URL string.

Maximum 2000 characters.

https://www.luckyshrub.com/shop?promo={{1}}

<URL_BUTTON_VAR_EXAMPLE>

String

Required if using a URL button.

URL of website. Supports 1 variable.

Maximum 2000 characters.

https://www.luckyshrub.com/shop?promo=summer_lemons_2023

Example Request

{
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "components": [{
            "type": "BODY",
            "text": "Rare succulents for sale! {{1}}, add these unique plants to your collection.",
            "example": {
                "body_text": [
                    [
                        "Pablo"
                    ]
                ]
            }
        }, {
            "type": "CAROUSEL",
            "cards": [

                {
                    "components": [{
                            "type": "HEADER",
                            "format": "PRODUCT"
                        },

                        {
                            "type": "buttons",
                            "buttons": [

                                {
                                    "type": "spm",
                                    "text": "View"
                                }

                            ]
                        }
                    ]
                },
                {
                    "components": [{
                            "type": "HEADER",
                            "format": "PRODUCT"
                        },

                        {
                            "type": "buttons",
                            "buttons": [

                                {
                                    "type": "spm",
                                    "text": "View"
                                }

                            ]
                        }
                    ]
                },
                {
                    "components": [{
                            "type": "HEADER",
                            "format": "PRODUCT"
                        },

                        {
                            "type": "buttons",
                            "buttons": [

                                {
                                    "type": "spm",
                                    "text": "View"
                                }

                            ]
                        }
                    ]
                }


            ]
        }
    ]
}

Example Response

{
    "category": "MARKETING",
    "components": [
    //Array of Components
    ],
    "external_id": "11987839xxxxxxxx",
    "id": "dDJN6HNxxxxxxxxxxxxxWT",
    "language": "en",
    "name": "template_name",
    "namespace": "ed620b19_xxxx_xxxx_xxxx_670f20036e2b",
    "rejected_reason": null,
    "status": "submitted"
}

Sending Product Card Carousel Templates

Catalog template messages cannot be sent with the On-Premises API.

Once your carousel template is approved, you can use the Cloud API to send it in a Product Card Carousel Template Message.

POST https://waba-v2.360dialog.io/messages

Request Body

Name
Type
Description

messaging_product

string

Required only for Cloud API. Messaging service used for the request. Use "whatsapp".

recipient_type

string

individual

to

string

Recipient phone number

type

string

template

name

string

Template name

language

string

Template language

code

string

Language code

components

Your template components array

Required.

Assemble your payload similar to the structure of the template you created.

Example with SPM View Button

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "phone_number",
  "type": "template",
  "template": {
    "name": "template_name",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Pablo"
          }
        ]
      },
      {
        "type": "carousel",
        "cards": [
          {
            "card_index": 0,
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "product",
                    "product": {
                      "product_retailer_id": "osb5529j3w",
                      "catalog_id": "419472613037220"
                    }
                  }
                ]
              }
            ]
          },
          {
            "card_index": 1,
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "product",
                    "product": {
                      "product_retailer_id": "huhn",
                      "catalog_id": "419472613037220"
                    }
                  }
                ]
              }
            ]
          },
          {
            "card_index": 2,
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "product",
                    "product": {
                      "product_retailer_id": "best_product_ever",
                      "catalog_id": "419472613037220"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

See more details in

Carousel templates support up to 10 carousel cards. Cards must have a media header (image or video) and can optionally include body text and up to 2 or (button types can be mixed).

To use product card carousel templates, you must have an ecommerce, with inventory, connected to your WhatsApp Business Account.

If you send a carousel template composed of product cards that use a View button, when a customer adds one or more products to their cart and submits an order, you will receive a webhook that .

With URL button flows, since order placement happens outside of the WhatsApp, webhooks are not triggered.

Template .

label text.

URL of website that loads in the device's default mobile web browser when the is tapped by the app user.

If using a variable, add sample variable property to the end of the URL string. The URL loads in the device's default mobile web browser when the customer taps the .

It is only possible to send Templates with an Active status. A message template's status can change automatically from Active to Paused or Disabled based on feedback from customers. For this reason, we recommend that you to take appropriate actions whenever a message template that you rely upon becomes, or is in danger of becoming, paused or disabled.

Single-Product Message Templates (View Button)
product catalog
monitor status changes
language and locale code
URL button
SPM buttons
Example Product Card Carrousel with View Button
Example Product Card Carrousel with URL Button
quick reply buttons, phone number buttons, or URL buttons
URL button
URL button
describes the order
describing the order