> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapfy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Send carousel

> Sends a carousel of swipeable cards, each with its own image or video, body text and buttons. Returns `{ messageId }`.



## OpenAPI

````yaml /en/api-reference/openapi.json post /messages/send-carousel
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    Multi-tenant WhatsApp API. Send messages and manage webhooks through a
    single surface.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /messages/send-carousel:
    post:
      tags:
        - Messages
      summary: Send carousel
      description: >-
        Sends a carousel of swipeable cards, each with its own image or video,
        body text and buttons. Returns `{ messageId }`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCarouselBody'
      responses:
        '200':
          $ref: '#/components/responses/MessageAccepted'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  schemas:
    SendCarouselBody:
      type: object
      required:
        - to
        - cards
      properties:
        to:
          $ref: '#/components/schemas/Recipient'
          description: >-
            Message recipient: phone in E.164 (e.g. 5511999998888) or a group
            id.
        body:
          type: string
          description: Optional message body shown above the cards.
          example: Check our news!
        footer:
          type: string
          description: Optional message footer shown below the cards.
          example: Zapfy
        cards:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/CarouselCard'
          description: Cards displayed in order. At least one card is required.
        delay:
          $ref: '#/components/schemas/Delay'
        quoted:
          $ref: '#/components/schemas/Quoted'
    Recipient:
      type: string
      description: >-
        Recipient: a phone in E.164 (with or without `+`, spaces or formatting,
        e.g. `5511999998888` or `+55 11 99999-8888`) or a group id. To send to a
        group, use the group id (from `GET /groups`).
      example: '5511999998888'
    CarouselCard:
      type: object
      required:
        - header
        - body
      description: >-
        A single card inside the carousel. Each card requires a header and a
        body.
      properties:
        header:
          $ref: '#/components/schemas/CarouselCardHeader'
        body:
          type: object
          required:
            - text
          description: Card body text.
          properties:
            text:
              type: string
              example: Card 1 — special offer
        footer:
          type: string
          description: Optional footer under the body.
          example: Limited time
        buttons:
          type: array
          items:
            $ref: '#/components/schemas/CarouselButton'
          description: Buttons shown on the card.
    Delay:
      type: integer
      description: >-
        Optional delay in milliseconds before sending; WhatsApp shows "typing…"
        during this interval.
    Quoted:
      type: object
      description: Quotes (replies to) a previous message.
      required:
        - messageId
      properties:
        messageId:
          type: string
          description: '`messageId` of the quoted message.'
          example: 3EB0C767D4...
        participant:
          type: string
          description: In a group, who sent the quoted message.
    MessageHandle:
      type: object
      description: >-
        Identifier of the sent message. Store the `messageId`: together with the
        same `to` you sent to, it is what `/messages/delete` and
        `/messages/edit` need.
      properties:
        messageId:
          type: string
          description: WhatsApp message ID.
          example: 3EB0C767D4...
    CarouselCardHeader:
      type: object
      description: >-
        Top area of a carousel card. Provide either `imageUrl` or `videoUrl`
        (image takes precedence).
      properties:
        title:
          type: string
          description: Optional title above the media.
          example: Deal of the day
        subtitle:
          type: string
          description: Optional subtitle below the title.
          example: Today only
        imageUrl:
          type: string
          description: Public image URL. Takes precedence over `videoUrl`.
          example: https://example.com/card1.jpg
        videoUrl:
          type: string
          description: Public video URL. Used only when `imageUrl` is empty.
          example: https://example.com/card1.mp4
    CarouselButton:
      type: object
      required:
        - type
        - displayText
      description: >-
        A button attached to a carousel card. NOTE: unlike /messages/send-button
        there is no `url`/`phoneNumber` field — for URL and CALL buttons put the
        link or phone number in `id`. PIX is not supported in carousel cards.
      properties:
        type:
          type: string
          enum:
            - REPLY
            - URL
            - CALL
            - COPY
          description: Card button type. One of REPLY, URL, CALL, COPY.
        displayText:
          type: string
          description: Label shown on the button (REPLY/COPY/URL/CALL). Ignored for PIX.
          example: Learn more
        id:
          type: string
          description: REPLY payload, or the URL (type=URL) / phone number (type=CALL).
          example: card1_info
        copyCode:
          type: string
          description: Code copied to the clipboard when type=COPY.
          example: PROMO2026
  responses:
    MessageAccepted:
      description: Message accepted by WhatsApp.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/MessageHandle'
    Error:
      description: Error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Account token (`zpfy_acct_...`) — manages instances and webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Instance token (`zpfy_inst_...`) — sends messages.

````