# Poll

## Get a poll's current tally

`client.messages.poll.retrieve(stringmessageID, RequestOptionsoptions?): PollEnvelope`

**get** `/v3/messages/{messageId}/poll`

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.

### Parameters

- `messageID: string`

### Returns

- `PollEnvelope`

  Message-level envelope returned by every poll endpoint.

  - `chat_id: string`

  - `created_at: string`

  - `message_id: string`

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

  - `poll: Poll`

    Poll content — options and the aggregate voter count.

    - `options: Array<Option>`

      - `can_be_edited: boolean`

      - `creator_handle: ChatHandle`

        The participant who added this option (poll creator for the initial options; whoever added later ones).

        - `id: string`

          Unique identifier for this handle

        - `handle: string`

          Phone number (E.164) or email address of the participant

        - `joined_at: string`

          When this participant joined the chat

        - `service: ServiceType`

          Messaging service type

          - `"iMessage"`

          - `"SMS"`

          - `"RCS"`

        - `is_me?: boolean | null`

          Whether this handle belongs to the sender (your phone number)

        - `left_at?: string | null`

          When they left (if applicable)

        - `status?: "active" | "left" | "removed" | null`

          Participant status

          - `"active"`

          - `"left"`

          - `"removed"`

      - `option_id: string`

      - `text: string`

      - `voters: Array<Voter>`

        Participants who voted for this option (vote_count = voters.length).

        - `handle: string`

        - `voted_at: string`

    - `total_voters: number`

      Distinct participants across the whole poll (a voter picking two options counts once).

  - `reactions: Array<Reaction>`

    Tapbacks/stickers on the whole poll (message part 0).

    - `handle: ChatHandle`

    - `is_me: boolean`

      Whether this reaction is from the current user

    - `type: ReactionType`

      Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
      Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
      Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

      - `"love"`

      - `"like"`

      - `"dislike"`

      - `"laugh"`

      - `"emphasize"`

      - `"question"`

      - `"custom"`

      - `"sticker"`

    - `custom_emoji?: string | null`

      Custom emoji if type is "custom", null otherwise

    - `sticker?: Sticker | null`

      Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions.

      - `file_name?: string`

        Filename of the sticker

      - `height?: number`

        Sticker image height in pixels

      - `mime_type?: string`

        MIME type of the sticker image

      - `url?: string`

        Presigned URL for downloading the sticker image (expires in 1 hour).

      - `width?: number`

        Sticker image width in pixels

  - `updated_at: string`

### Example

```typescript
import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const pollEnvelope = await client.messages.poll.retrieve('69a37c7d-af4f-4b5e-af42-e28e98ce873a');

console.log(pollEnvelope.chat_id);
```

#### Response

```json
{
  "chat_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2019-12-27T18:11:19.117Z",
  "message_id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
  "poll": {
    "options": [
      {
        "can_be_edited": true,
        "creator_handle": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "handle": "+15551234567",
          "joined_at": "2025-05-21T15:30:00.000-05:00",
          "service": "iMessage",
          "is_me": false,
          "left_at": "2019-12-27T18:11:19.117Z",
          "status": "active"
        },
        "option_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "text": "Tacos",
        "voters": [
          {
            "handle": "+14155559876",
            "voted_at": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    ],
    "total_voters": 0
  },
  "reactions": [
    {
      "handle": {
        "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
        "handle": "+15551234567",
        "joined_at": "2025-05-21T15:30:00.000-05:00",
        "service": "iMessage",
        "is_me": false,
        "left_at": "2019-12-27T18:11:19.117Z",
        "status": "active"
      },
      "is_me": false,
      "type": "love",
      "custom_emoji": null,
      "sticker": {
        "file_name": "sticker.png",
        "height": 420,
        "mime_type": "image/png",
        "url": "https://cdn.linqapp.com/attachments/a1b2c3d4/sticker.png?signature=...",
        "width": 420
      }
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

# Options

## Add options to a poll

`client.messages.poll.options.create(stringmessageID, OptionCreateParamsbody, RequestOptionsoptions?): PollEnvelope`

**post** `/v3/messages/{messageId}/poll/options`

Add one or more options to an existing poll. Options are **add-only and immutable** — you
can append options but never edit or remove them (Apple constraint). Returns the full poll.

### Parameters

- `messageID: string`

- `body: OptionCreateParams`

  - `options: Array<Option>`

    - `text: string`

### Returns

- `PollEnvelope`

  Message-level envelope returned by every poll endpoint.

  - `chat_id: string`

  - `created_at: string`

  - `message_id: string`

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

  - `poll: Poll`

    Poll content — options and the aggregate voter count.

    - `options: Array<Option>`

      - `can_be_edited: boolean`

      - `creator_handle: ChatHandle`

        The participant who added this option (poll creator for the initial options; whoever added later ones).

        - `id: string`

          Unique identifier for this handle

        - `handle: string`

          Phone number (E.164) or email address of the participant

        - `joined_at: string`

          When this participant joined the chat

        - `service: ServiceType`

          Messaging service type

          - `"iMessage"`

          - `"SMS"`

          - `"RCS"`

        - `is_me?: boolean | null`

          Whether this handle belongs to the sender (your phone number)

        - `left_at?: string | null`

          When they left (if applicable)

        - `status?: "active" | "left" | "removed" | null`

          Participant status

          - `"active"`

          - `"left"`

          - `"removed"`

      - `option_id: string`

      - `text: string`

      - `voters: Array<Voter>`

        Participants who voted for this option (vote_count = voters.length).

        - `handle: string`

        - `voted_at: string`

    - `total_voters: number`

      Distinct participants across the whole poll (a voter picking two options counts once).

  - `reactions: Array<Reaction>`

    Tapbacks/stickers on the whole poll (message part 0).

    - `handle: ChatHandle`

    - `is_me: boolean`

      Whether this reaction is from the current user

    - `type: ReactionType`

      Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
      Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
      Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

      - `"love"`

      - `"like"`

      - `"dislike"`

      - `"laugh"`

      - `"emphasize"`

      - `"question"`

      - `"custom"`

      - `"sticker"`

    - `custom_emoji?: string | null`

      Custom emoji if type is "custom", null otherwise

    - `sticker?: Sticker | null`

      Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions.

      - `file_name?: string`

        Filename of the sticker

      - `height?: number`

        Sticker image height in pixels

      - `mime_type?: string`

        MIME type of the sticker image

      - `url?: string`

        Presigned URL for downloading the sticker image (expires in 1 hour).

      - `width?: number`

        Sticker image width in pixels

  - `updated_at: string`

### Example

```typescript
import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const pollEnvelope = await client.messages.poll.options.create(
  '69a37c7d-af4f-4b5e-af42-e28e98ce873a',
  { options: [{ text: 'Pizza' }] },
);

console.log(pollEnvelope.chat_id);
```

#### Response

```json
{
  "chat_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2019-12-27T18:11:19.117Z",
  "message_id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
  "poll": {
    "options": [
      {
        "can_be_edited": true,
        "creator_handle": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "handle": "+15551234567",
          "joined_at": "2025-05-21T15:30:00.000-05:00",
          "service": "iMessage",
          "is_me": false,
          "left_at": "2019-12-27T18:11:19.117Z",
          "status": "active"
        },
        "option_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "text": "Tacos",
        "voters": [
          {
            "handle": "+14155559876",
            "voted_at": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    ],
    "total_voters": 0
  },
  "reactions": [
    {
      "handle": {
        "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
        "handle": "+15551234567",
        "joined_at": "2025-05-21T15:30:00.000-05:00",
        "service": "iMessage",
        "is_me": false,
        "left_at": "2019-12-27T18:11:19.117Z",
        "status": "active"
      },
      "is_me": false,
      "type": "love",
      "custom_emoji": null,
      "sticker": {
        "file_name": "sticker.png",
        "height": 420,
        "mime_type": "image/png",
        "url": "https://cdn.linqapp.com/attachments/a1b2c3d4/sticker.png?signature=...",
        "width": 420
      }
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

# Votes

## Toggle a vote on a poll option

`client.messages.poll.votes.create(stringmessageID, VoteCreateParamsbody, RequestOptionsoptions?): PollEnvelope`

**post** `/v3/messages/{messageId}/poll/votes`

Add or remove your line's vote on **one** poll option (per-option toggle — iMessage polls
are toggled one option at a time). Returns the poll reflecting the toggle.

### Parameters

- `messageID: string`

- `body: VoteCreateParams`

  - `operation: "add" | "remove"`

    Add or remove your line's vote on the option.

    - `"add"`

    - `"remove"`

  - `option_id: string`

    The option to toggle a vote on.

### Returns

- `PollEnvelope`

  Message-level envelope returned by every poll endpoint.

  - `chat_id: string`

  - `created_at: string`

  - `message_id: string`

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

  - `poll: Poll`

    Poll content — options and the aggregate voter count.

    - `options: Array<Option>`

      - `can_be_edited: boolean`

      - `creator_handle: ChatHandle`

        The participant who added this option (poll creator for the initial options; whoever added later ones).

        - `id: string`

          Unique identifier for this handle

        - `handle: string`

          Phone number (E.164) or email address of the participant

        - `joined_at: string`

          When this participant joined the chat

        - `service: ServiceType`

          Messaging service type

          - `"iMessage"`

          - `"SMS"`

          - `"RCS"`

        - `is_me?: boolean | null`

          Whether this handle belongs to the sender (your phone number)

        - `left_at?: string | null`

          When they left (if applicable)

        - `status?: "active" | "left" | "removed" | null`

          Participant status

          - `"active"`

          - `"left"`

          - `"removed"`

      - `option_id: string`

      - `text: string`

      - `voters: Array<Voter>`

        Participants who voted for this option (vote_count = voters.length).

        - `handle: string`

        - `voted_at: string`

    - `total_voters: number`

      Distinct participants across the whole poll (a voter picking two options counts once).

  - `reactions: Array<Reaction>`

    Tapbacks/stickers on the whole poll (message part 0).

    - `handle: ChatHandle`

    - `is_me: boolean`

      Whether this reaction is from the current user

    - `type: ReactionType`

      Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
      Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
      Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

      - `"love"`

      - `"like"`

      - `"dislike"`

      - `"laugh"`

      - `"emphasize"`

      - `"question"`

      - `"custom"`

      - `"sticker"`

    - `custom_emoji?: string | null`

      Custom emoji if type is "custom", null otherwise

    - `sticker?: Sticker | null`

      Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions.

      - `file_name?: string`

        Filename of the sticker

      - `height?: number`

        Sticker image height in pixels

      - `mime_type?: string`

        MIME type of the sticker image

      - `url?: string`

        Presigned URL for downloading the sticker image (expires in 1 hour).

      - `width?: number`

        Sticker image width in pixels

  - `updated_at: string`

### Example

```typescript
import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const pollEnvelope = await client.messages.poll.votes.create(
  '69a37c7d-af4f-4b5e-af42-e28e98ce873a',
  { operation: 'add', option_id: '97ce8c17-7ef6-4bbc-a89a-6b93d189712f' },
);

console.log(pollEnvelope.chat_id);
```

#### Response

```json
{
  "chat_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2019-12-27T18:11:19.117Z",
  "message_id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
  "poll": {
    "options": [
      {
        "can_be_edited": true,
        "creator_handle": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "handle": "+15551234567",
          "joined_at": "2025-05-21T15:30:00.000-05:00",
          "service": "iMessage",
          "is_me": false,
          "left_at": "2019-12-27T18:11:19.117Z",
          "status": "active"
        },
        "option_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "text": "Tacos",
        "voters": [
          {
            "handle": "+14155559876",
            "voted_at": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    ],
    "total_voters": 0
  },
  "reactions": [
    {
      "handle": {
        "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a",
        "handle": "+15551234567",
        "joined_at": "2025-05-21T15:30:00.000-05:00",
        "service": "iMessage",
        "is_me": false,
        "left_at": "2019-12-27T18:11:19.117Z",
        "status": "active"
      },
      "is_me": false,
      "type": "love",
      "custom_emoji": null,
      "sticker": {
        "file_name": "sticker.png",
        "height": 420,
        "mime_type": "image/png",
        "url": "https://cdn.linqapp.com/attachments/a1b2c3d4/sticker.png?signature=...",
        "width": 420
      }
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```