--- updatedAt: 2026-07-14T10:24:25.000Z agentTools: projectIndex: https://partner-docs.gupshup.io/llms.txt --- # Carousel (Image) Use this API to send messages with the Carousel template (Image). ## Request Parameters
Key Description Value Data type Required/Optional Constraints
Authorization Access Token for the application `{{PARTNER_APP_TOKEN}}` String Required Should be a valid Partner App Access Token
source Source Phone Number `{{SOURCE}}` Integer Required
sandbox Boolean value `{SANDBOX}` Boolean Optional
destination Destination Phone Number `{{DESTINATION}}` Integer Required
template Json containing template details `{ "id": "\", "params": [ \ ]}` String Required
message Message Json `{ "type": "carousel", "cardHeaderType": "", "cards": [ { "id": "" }, { "link": "" } ] }` String Required For the carousel, the message json will contain each card’s media (represented by either ID/link)
src.name App Name `{{APP_NAME}}` String Required
APP\_ID App ID to fetch the access token String Required - The Id should be a valid app Id of Gupshup - The App must be associated with the account that owns the PARTNER\_APP\_TOKEN being used
userId BSUID {{userId}}
## Sample Request ```curl curl --request POST \ --url https://partner.gupshup.io/partner/app/947d28b8-459b-4dfe-9d4c-0ac8c6c245c9/template/msg \ --header 'accept: application/json' \ --header 'content-type: application/x-www-form-urlencoded' \ --header 'token: sk_711916ad1d5d4f21a9520fdef20516a1' \ --data source=919643874844 \ --data sandbox=true \ --data destination=918886912227 \ --data 'template={"id":"5d856a59-2990-4197-a502-8af90bfac11a","params":["user"]}' \ --data src.name=ProdMonitoringCloud \ --data 'userId={{BSUID}}' \ --data 'message={"type":"carousel","cardHeaderType":"IMAGE","cards":[{"link":"https://fastly.picsum.photos/id/13/2500/1667.jpg?hmac=SoX9UoHhN8HyklRA4A3vcCWJMVtiBXUg0W4ljWTor7s"},{"link":"https://fastly.picsum.photos/id/25/5000/3333.jpg?hmac=yCz9LeSs-i72Ru0YvvpsoECnCTxZjzGde805gWrAHkM"},{"link":"https://fastly.picsum.photos/id/28/4928/3264.jpg?hmac=GnYF-RnBUg44PFfU5pcw_Qs0ReOyStdnZ8MtQWJqTfA"},{"link":"https://fastly.picsum.photos/id/27/3264/1836.jpg?hmac=p3BVIgKKQpHhfGRRCbsi2MCAzw8mWBCayBsKxxtWO8g"}]}' ``` ## Sample Response ```json { "status": "submitted", "messageId": "76581256-df63-4823-b03d-e7c5d169f934" } ``` ## Status Codes | Status Code | Response | Comments | | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------- | | **Success** | | | | 200 | `{ "status": "submitted", "messageId": "76581256-df63-4823-b03d-e7c5d169f934" }` | | | **Error** | | | | 429 | `{ "status": "error", "message": "Too Many Requests" }` | 10 Requests per Minute | | 500 | `{ "status": "error", "message": "Internal server error. Please try again later. If the issue still persists, then contact Gupshup Dev Support" }` | For any Internal Error |
# OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Carousel send message", "version": "1.0.0" }, "servers": [ { "url": "https://partner.gupshup.io" } ], "paths": { "/partner/app/{appId}/template/msg": { "post": { "tags": [ "default" ], "summary": "Carousel (Image)", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "source", "destination", "template", "src.name", "message" ], "properties": { "source": { "type": "integer", "description": "Source Phone Number", "example": "918929874278" }, "sandbox": { "type": "boolean", "description": "Boolean value", "example": "false" }, "destination": { "type": "integer", "description": "Destination Phone Number", "example": "918888998545" }, "template": { "type": "string", "description": "Json containing template details", "example": "{\"id\":\"5d856a59-2990-4197-a502-8af90bfac11a\",\"params\":[\"user\"]}" }, "src.name": { "type": "string", "description": "App Name", "example": "august18" }, "message": { "type": "string", "description": "Message Json", "example": "{\"type\":\"carousel\",\"cardHeaderType\":\"IMAGE\",\"cards\":[{\"link\":\"https://fastly.picsum.photos/id/13/2500/1667.jpg?hmac=SoX9UoHhN8HyklRA4A3vcCWJMVtiBXUg0W4ljWTor7s\"},{\"link\":\"https://fastly.picsum.photos/id/25/5000/3333.jpg?hmac=yCz9LeSs-i72Ru0YvvpsoECnCTxZjzGde805gWrAHkM\"},{\"link\":\"https://fastly.picsum.photos/id/28/4928/3264.jpg?hmac=GnYF-RnBUg44PFfU5pcw_Qs0ReOyStdnZ8MtQWJqTfA\"},{\"link\":\"https://fastly.picsum.photos/id/27/3264/1836.jpg?hmac=p3BVIgKKQpHhfGRRCbsi2MCAzw8mWBCayBsKxxtWO8g\"}]}" } } } } } }, "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": { "status": { "type": "string", "example": "submitted" }, "messageId": { "type": "string", "example": "183dc8f1-7ecc-4419-895f-04fd0b1bfe07" } } } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "string", "example": "error" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Internal server error" }, "status": { "type": "string", "example": "error" } } } } } } }, "description": "Use this API to send messages with the Carousel template (Image)." } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```