API Reference

Send Carousel

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Send a carousel message

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.

Body ParametersJSONExpand Collapse

from_number: string

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

media_urls: array of string

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

number: string

Recipient phone number in E.164 format

metadata: optional unknown

Additional metadata to attach to the message

send_style: optional "celebration" or "shooting_star" or "fireworks" or 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: optional string

Webhook URL for message status updates

formaturi

ReturnsExpand Collapse

accountEmail: optional string

Email of the account that sent the message

from_number: optional string

Sending phone number

is_outbound: optional boolean

media_url: optional string

First media URL from the carousel

message_handle: optional string

Unique identifier for tracking the message

message_type: optional string

number: optional string

Recipient phone number

status: optional string

Send a carousel message

HTTP

HTTP

TypeScript

Python

curl https://api.sendblue.co/api/send-carousel \
    -H 'Content-Type: application/json' \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET" \
    -d '{
          "from_number": "+19998887777",
          "media_urls": [
            "https://example.com/image1.jpg",
            "https://example.com/image2.jpg",
            "https://example.com/image3.jpg"
          ],
          "number": "+19998887777",
          "send_style": "celebration",
          "status_callback": "https://example.com/webhook"
        }'

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"
}