Session Messages
Send Carousel Message
Send a horizontally scrollable carousel of cards. Each card can have an image, text, and buttons.
Authorization
ApiKeyAuth X-API-Key<token>
API key from your dashboard (Settings > API Keys)
In: header
Header Parameters
X-AGENT-ID?string
Optional. Attribute this send to a specific agent, overriding the agent bound to the API key. The agent must belong to your account and be active (role AGENT, parent = your account) — otherwise the request returns 400. Drives customer assignment, agent allotment limits, and the wallet ledger entry.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/messages/send#carousel" \ -H "X-AGENT-ID: agt_abc123" \ -H "Content-Type: application/json" \ -d '{ "to": "919876543210", "message": { "message_type": "carousel", "text": "Check out our products", "cards": [ { "text": "Product A - Premium quality widget", "attachments": { "type": "image", "attachment": "https://example.com/product-a.jpg" }, "buttons": [ { "button_type": "text", "button_text": "Buy Now", "button_payload": "buy_product_a" } ] }, { "text": "Product B - Budget friendly option", "attachments": { "type": "image", "attachment": "https://example.com/product-b.jpg" }, "buttons": [ { "button_type": "text", "button_text": "Buy Now", "button_payload": "buy_product_b" } ] } ] } }'{
"success": true,
"data": {
"id": "clx9abc123def456"
}
}{
"success": false,
"message": "to field is required"
}{
"success": false,
"message": "user not authenticated"
}{
"success": false,
"message": "insufficient balance to send message"
}{
"success": false,
"message": "internal server error"
}