API Reference

Send Carousel

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Send a carousel message

client.sendCarousel.send(SendCarouselSendParams { from_number, media_urls, number, 3 more } body, RequestOptionsoptions?): SendCarouselSendResponse { accountEmail, from_number, is_outbound, 5 more }

POST/api/send-carousel

Send a carousel of images to a single recipient. Requires a V2 (Mac Mini) line. The carousel must contain between 2 and 20 HTTPS image URLs. For sending a single image, use /api/send-message with media_url instead.

ParametersExpand Collapse

body: SendCarouselSendParams { from_number, media_urls, number, 3 more }

from_number: string

Your Sendblue phone number in E.164 format (must be a V2/Mac Mini line)

media_urls: Array<string>

Array of HTTPS image URLs to send as a carousel (2-20 items)

number: string

Recipient phone number in E.164 format

metadata?: unknown

Additional metadata to attach to the message

send_style?: "celebration" | "shooting_star" | "fireworks" | 10 more

The iMessage expressive message style

One of the following:

"celebration"

"shooting_star"

"fireworks"

"lasers"

"love"

"confetti"

"balloons"

"spotlight"

"echo"

"invisible"

"gentle"

"loud"

"slam"

status_callback?: string

Webhook URL for message status updates

formaturi

ReturnsExpand Collapse

SendCarouselSendResponse { accountEmail, from_number, is_outbound, 5 more }

accountEmail?: string

Email of the account that sent the message

from_number?: string

Sending phone number

is_outbound?: boolean

media_url?: string

First media URL from the carousel

message_handle?: string

Unique identifier for tracking the message

message_type?: string

number?: string

Recipient phone number

status?: string

Send a carousel message

TypeScript

HTTP

TypeScript

Python

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: process.env['SENDBLUE_API_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SENDBLUE_API_API_SECRET'], // This is the default and can be omitted
});

const response = await client.sendCarousel.send({
  from_number: '+19998887777',
  media_urls: [
    'https://example.com/image1.jpg',
    'https://example.com/image2.jpg',
    'https://example.com/image3.jpg',
  ],
  number: '+19998887777',
});

console.log(response.accountEmail);

200 example

{
  "accountEmail": "[email protected]",
  "from_number": "+19998887777",
  "is_outbound": true,
  "media_url": "https://example.com/image1.jpg",
  "message_handle": "msg_abc123def456",
  "message_type": "carousel",
  "number": "+19998887777",
  "status": "QUEUED"
}

Returns Examples

200 example

{
  "accountEmail": "[email protected]",
  "from_number": "+19998887777",
  "is_outbound": true,
  "media_url": "https://example.com/image1.jpg",
  "message_handle": "msg_abc123def456",
  "message_type": "carousel",
  "number": "+19998887777",
  "status": "QUEUED"
}