Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-carousel
Send carousel
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-carousel \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "carousel": [
    {
      "text": "<string>",
      "image": "<string>",
      "buttons": [
        {
          "id": "<string>",
          "label": "<string>",
          "type": "<string>",
          "url": "<string>",
          "phone": "<string>"
        }
      ]
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

With this method you can send carousel messages with images, text and action buttons. From the action buttons, you can redirect to links, make calls, and also provide standard responses.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
​
message
string
required
Message text
​
carousel
array
required
Array of carousel cards

​
Optional

​
delayMessage
number
Delay added to the message. You can choose between a range of 1 to 15 sec, meaning how many seconds it will wait before sending the next message. (E.g.: “delayMessage”: 5). The default delay if not provided is 1 to 3 sec

​
Request Body

{
  "phone": "551199999999",
  "message": "Message text",
  "carousel": [
    {
      "text": "Card text",
      "image": "https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media",
      "buttons": [
        {
          "id": "1",
          "label": "Button name",
          "url": "https://z-api.io",
          "type": "URL"
        },
        {
          "id": "2",
          "label": "Button name",
          "type": "REPLY"
        }
      ]
    },
    {
      "text": "Card text",
      "image": "https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media",
      "buttons": [
        {
          "id": "1",
          "label": "Button name",
          "url": "https://z-api.io",
          "type": "URL"
        },
        {
          "id": "2",
          "label": "Button name",
          "type": "REPLY"
        }
      ]
    }
  ]
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.