v1

latestOpenAPI 3.0.32026-07-268345159.5 KB

default

Send Product Card Carousel Template

Use this API to send product card carousel as template

post/partner/app/{appId}/v3/message

Path parameters

appIdstring required

Unique identifier of the app.

Headers

tokenstring required

Your app token, please refer Get access token api to get the token from partner documentation.

Request body

object required

Example request

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<WHATSAPP_USER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<TEMPLATE_LANGUAGE>"
    },
    "components": [
      {
        "type": "body",
        "parameters": []
      },
      {
        "type": "carousel",
        "cards": [
          {
            "card_index": 0,
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "product",
                    "product": {
                      "product_retailer_id": "<PRODUCT_ID>",
                      "catalog_id": "<CATALOG_ID>"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Response

Successful response

messaging_productstring

Example response

{
  "messages": [
    {
      "id": "GUPSHUP_MESSAGE_ID"
    }
  ],
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "DESTINATION_PHONE_NO",
      "wa_id": "DESTINATION_PHONE_NO"
    }
  ]
}