Skip to main content
Version: v2

GetPollInfoResponse

Poll information

pollIdstringrequired

Poll ID

Example: gIQffAsGi8
messageIdstringrequired

ID of the message the poll was created in

Example: gIQffAsGi8
questionstringrequired

Text of the poll question

Example: Which option do you choose?
optionsstring[]required

Array of answer options

Example: ["Option 1","Option 2","Option 3"]
isMultiplebooleanrequired

Whether multiple answer options can be selected

Example: true
isAnonymousbooleanrequired

Anonymous voting

Example: false
summary objectrequired

Summary of the poll results

votes object[]required

Array of vote counts per answer option

  • Array [
  • optionintegerrequired

    Index of the answer option (starting from 0)

    Example: 0
    votesCountinteger<int64>required

    Number of votes for this option

    Example: 15
  • ]
  • totalVotersinteger<int64>required

    Total number of voters

    Example: 42
    firstVotedMemberIdsstring[]

    Array of membershipId values of the first members who voted

    myVoteinteger[]required

    Array of indices of the answer options selected by the current user

    GetPollInfoResponse
    {
    "pollId": "gIQffAsGi8",
    "messageId": "gIQffAsGi8",
    "question": "Which option do you choose?",
    "options": [
    "Option 1",
    "Option 2",
    "Option 3"
    ],
    "isMultiple": true,
    "isAnonymous": false,
    "summary": {
    "votes": [
    {
    "option": 0,
    "votesCount": 15
    }
    ],
    "totalVoters": 42,
    "firstVotedMemberIds": [
    "string"
    ]
    },
    "myVote": [
    0
    ]
    }