Skip to main content
POST
Send carousel

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
number
string
required

Recipient phone in E.164 without +, or a JID.

Example:

"5511999999999"

cards
object[]

Array of card objects (see fields below).

Example:
cards[].text
string

Card body text.

cards[].thumbnailUrl
string

URL of the card thumbnail image.

Card footer text.

cards[].buttons
object[]

Buttons for the card (same shape as sendButtons).

title
string

Carousel title.

Example:

"Featured products"

description
string

Carousel body text.

Example:

"Swipe to browse"

Carousel footer text.

Example:

"Pilot Status"

delay
integer

Delay before sending, in milliseconds.

everyOne
boolean

Mention everyone in the group.

mentioned
string[]

Array of numeric strings to mention.

Response

Success — provider-native response body.

Sent a carousel message (multiple interactive cards). Returns the persisted Baileys messageRaw envelope containing an interactiveMessage with a carouselMessage of cards.

key
object
pushName
string
status
enum<string>
Available options:
ERROR,
PENDING,
SERVER_ACK,
DELIVERY_ACK,
READ,
PLAYED
message
object
contextInfo
object | null
messageType
string
messageTimestamp
integer
instanceId
string
source
string