Skip to main content
POST
Reply to option list

Concept

This endpoint allows you to reply to an option list, simulating a user tap on one of the options previously sent via send-option-list.
The list must have been previously sent or received. The option ID must match the id defined for that option when the list was sent or in the received webhook.

Example on WhatsApp


Attributes

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

Required

string
required
Phone number (or group ID) in the format COUNTRY CODE + AREA CODE + NUMBER. Example: 551199999999
string
required
ID of the option list message being replied to.
string
required
ID of the selected option. It must be the same id defined in the list when it was sent.

Request Body

Response

200

string
Message ID in Z-API
string
Message ID in WhatsApp
string
Added for Zapier compatibility, it has the same value as messageId

400

Make sure the request body is present and the required fields (phone, messageId and responseOptionId) are filled in.

405

Make sure you are using the correct HTTP method (POST).

415

Make sure to include the Content-Type: application/json header.