--- updatedAt: 2026-06-26T07:23:09.000Z agentTools: projectIndex: https://partner-docs.gupshup.io/llms.txt --- # Send Product Card Carousel Template Use this API to send product card carousel as template Product card carousel templates allow you to send a single text message accompanied by a set of up to 10 product cards in a horizontally scrollable view > 📘 Note: > > 1. Use the `recipient` parameter only when BSUID is enabled for the app. > 2. When both `to` and `recipient` fields are used in the payload, the `to` field gets the priority. ## Request Parameters {`

Key	Description	Values	Data Types	Required/Optional	Constraints
Authorization	Access Token for the application	{{PARTNER_APP_TOKEN}}	String	Required	Should be a valid Partner App Access Token.
APP ID	App ID to fetch the access token	`bf9ee64c-3d4d-4ac4-xxxx-732e577007c4`	String	Required	The Id should be a valid app Id of Gupshup
messaging_product	Messaging product	whatsapp	String	Required
recipient_type	Recipient type	individual	String	Required
to	Destination phone number where the message needs to be sent	91785876xxxx	String	Required (Can be optional if BSUID is enabled for the app and recipient parameter is used instead)	Must be a valid phone number
recipient	Destination BSUID where the message needs to be sent	IN.461449821882xxxx	String	Optional	Must be a valid BSUID
type	Messaging type	video	String	Required	Type should be `video` to send video message.
template	Template message inside body	"template": { "name": "Template" ...... }	Object	Required	Key should be template to send template message.

`} ## Sample Request ```curl curl --location 'https://partner.gupshup.io/partner/app//v3/message' \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --data '{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": "", "recipient": "", "type": "template", "template": { "name": "", "language": { "code": "" }, "components": [ { "type": "body", "parameters": [ , ] }, { "type": "carousel", "cards": [ { "card_index": , "components": [ { "type": "header", "parameters": [ { "type": "product", "product": { "product_retailer_id": "", "catalog_id": "" } } ] } ] } /* Addt'l cards would follow. */ ] } ] } }' ``` ## Sample Response ```json { "messages": [ { "id": "GUPSHUP_MESSAGE_ID" } ], "messaging_product": "whatsapp", "contacts": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] } ``` ## Status Codes | Status Code | Response | Comments | | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------- | | **Success** | | | | 200 | `{ "messages": [ { "id": "GUPSHUP_MESSAGE_ID" } ], "messaging_product": "whatsapp", "contacts": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] }` | | | **Error** | | | | 401 | `{ "status": "error", "message": "Authentication Failed" }` | When API key authentication fails | | 400 | `{ "message": "Callback Billing must be enabled for this API", "status": "error" }` | If Callback billing is not enabled for the app | | 400 | `{ "message": "Invalid App Details", "status": "error" }` | If app details are not found | # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Partner Portal API", "version": "1.0.0" }, "servers": [ { "url": "https://partner.gupshup.io" } ], "paths": { "/partner/app/{appId}/v3/message": { "post": { "tags": [ "default" ], "summary": "Send Product Card Carousel Template", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "messaging_product": "whatsapp", "recipient_type": "individual", "to": "", "type": "template", "template": { "name": "", "language": { "code": "" }, "components": [ { "type": "body", "parameters": [] }, { "type": "carousel", "cards": [ { "card_index": 0, "components": [ { "type": "header", "parameters": [ { "type": "product", "product": { "product_retailer_id": "", "catalog_id": "" } } ] } ] } ] } ] } } } } } }, "parameters": [ { "name": "token", "in": "header", "schema": { "type": "string" }, "description": "Your app token, please refer [**Get access token api**](https://docs.gupshup.io/reference/get_partner-app-appid-token) to get the token from partner documentation.", "example": "sk_61b3021c97214370b341f8baaae0xxxx", "required": true }, { "name": "appId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "Unique identifier of the app.", "example": "9e97650d-xxxx-xxxx-xxxx-4cdf47c3fa68" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "GUPSHUP_MESSAGE_ID" } } }, "example": [ { "id": "GUPSHUP_MESSAGE_ID" } ] }, "messaging_product": { "type": "string", "example": "whatsapp" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "input": { "type": "string", "example": "DESTINATION_PHONE_NO" }, "wa_id": { "type": "string", "example": "DESTINATION_PHONE_NO" } } }, "example": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Callback Billing must be enabled for this API" }, "status": { "type": "string", "example": "error" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Authentication Failed" }, "status": { "type": "string", "example": "error" } } } } } } }, "description": "Use this API to send product card carousel as template" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```