Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-button-list
Send buttons with image
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-button-list \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "buttonList": {
    "image": "<string>",
    "buttons": [
      {
        "label": "<string>",
        "id": "<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 images with action button options, the button content e.g.: YES / No, can be chosen by the user.
Button sending is currently available, but there are some decisive factors for it to work. For more details check the Button Status topic.
The message attribute cannot be sent empty!

​
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
Text to be sent
​
buttonList
object
required
Object with image and button list

​
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": "5511999999999",
  "message": "Is Z-API Good?",
  "buttonList": {
    "image": "https://avatars.githubusercontent.com/u/60630101?s=280&v=4",
    "buttons": [
      {
        "id": "1",
        "label": "Great"
      },
      {
        "id": "2",
        "label": "Excellent"
      }
    ]
  }
}

​
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”.