message

vote on poll

Submits a vote on an existing poll message with the specified options.

post/instances/{id}/client/action/vote-on-poll

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/vote-on-poll
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

The serialized message ID of the poll to vote on

selectedOptionsstring[] required

Array of option names to vote for

Example request

{
  "messageId": "true_1234567890@c.us_ABCDEF1234567890",
  "selectedOptions": [
    "Red",
    "Blue"
  ]
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Vote submitted successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "messageId": "true_1234567890@c.us_ABCDEF1234567890",
      "voted": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.