Messages

Get a poll's current tally

Return a poll's current results — its options, each option's voters, and the distinct total number of voters — by the poll-definition message's ID.

get/v3/messages/{messageId}/poll

Request

Base URL: https://api.linqapp.com/api/partner
URL: https://api.linqapp.com/api/partner/v3/messages/{messageId}/poll
Auth: HTTP bearer

Path parameters

messageIdstring uuid required

Example:69a37c7d-af4f-4b5e-af42-e28e98ce873a

The poll-definition message's ID

Response

The poll's current tally

chat_idstring uuid required

message_idstring uuid required

The poll-definition message's ID — reference this poll by it.

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "chat_id": "550e8400-e29b-41d4-a716-446655440000",
  "message_id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
  "reactions": [
    {
      "is_me": false,
      "handle": {
        "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
        "display_name": "Alice",
        "handle": "+15551234567"
      },
      "type": "love",
      "custom_emoji": null,
      "sticker": null
    }
  ],
  "poll": {
    "options": [
      {
        "text": "Tacos",
        "creator_handle": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "handle": "+15551234567",
          "service": "iMessage",
          "joined_at": "2025-05-21T15:30:00.000-05:00",
          "line_type": "iMessage"
        },
        "voters": [
          {
            "handle": "+14155559876"
          }
        ]
      }
    ]
  }
}

Changes

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