Skip to main content
POST
Send carousel

Overview

Method for sending messages with a card carousel. Each card can contain an image, text, and action buttons (CALL, URL, or REPLY).

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Body

application/json
phone
string
required

Recipient phone number (country code + area code + number)

Example:

"5511999999999"

message
string
required

Message text

List of carousel cards

delayMessage
integer

Delay in seconds before sending (1-15)

Required range: 1 <= x <= 15

Response

Message sent successfully

zaapId
string

Internal identifier

messageId
string

WhatsApp message ID

id
string

Same value as messageId (compatibility)