Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-option-list
Send option list
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-option-list \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "optionList": {
    "title": "<string>",
    "buttonLabel": "<string>",
    "options": [
      {
        "title": "<string>",
        "description": "<string>",
        "id": "<string>"
      }
    ]
  }
}
'

​
Overview

With this method you can send text messages with an option list, where the user can select one of the sent options.
The option list feature no longer works in groups.

​
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
​
optionList
object
required
List configuration

​
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": "Select the best option:",
  "optionList": {
    "title": "Available options",
    "buttonLabel": "Open option list",
    "options": [
      {
        "id": "1",
        "description": "Z-API Wings for your imagination",
        "title": "Z-API"
      },
      {
        "id": "2",
        "description": "Don't work",
        "title": "Others"
      }
    ]
  }
}

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