Sign in

v1

latestSwagger 2.02026-07-1791478483.9 KB
Send Message

Send a carousel message

Send an interactive carousel (multiple swipeable cards). Each card carries its own image or video, body and optional buttons.

Card button type accepted values (case-insensitive, uppercased internally): REPLY (default), URL, CALL, COPY. The PIX button type is NOT supported in carousel cards — use /send/button for PIX.

IMPORTANT — CarouselButtonStruct is different from the flat button used in /send/button:

  • URL button: put the link in the id field (NOT in a url field).
  • CALL button: put the phone number in the id field (NOT in a phoneNumber field).
  • COPY button: put the code to be copied in copyCode.
  • REPLY button: put the payload/callback ID in id.

Per-card combination rules (NOT enforced by the server, but verified in the field):

  • Same WhatsApp Web quirk as /send/button: avoid mixing REPLY with CTA buttons (URL/CALL/COPY) in the same card — mixed sets do not render on Web.
  • Stick to either "only REPLY" or "only CTAs grouped together" per card.

Required body fields: number, cards (at least one). Each card requires header + body.

post/send/carousel

Request body

bodystring

Optional message body shown above the cards.

delayinteger

Typing delay (milliseconds) applied before sending the message.

footerstring

Optional message footer shown below the cards.

formatJidboolean

If false, skips automatic formatting/validation of number into a JID.

numberstring

Destination phone number.

Example request

{
  "body": "Confira nossas novidades!",
  "cards": [
    {
      "body": {
        "text": "Card 1 - Oferta especial"
      },
      "buttons": [
        {
          "copyCode": "PROMO2026",
          "displayText": "Quero saber mais",
          "id": "card1_info",
          "type": "REPLY"
        }
      ],
      "footer": "Por tempo limitado",
      "header": {
        "imageUrl": "https://picsum.photos/seed/card1/600/400",
        "subtitle": "Somente hoje",
        "title": "Oferta do dia"
      }
    }
  ],
  "delay": 1200,
  "footer": "Evolution GO",
  "number": "5582988898565"
}

Response

success

GinH required