Messages

Add options to a poll

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.

On a zero-day-retention line, options must include every existing option (in the order they were originally created) followed by the new one(s), not just the new option(s). Zero-day-retention polls never store option text, so this request is the only place that text still exists — it's required to correctly render the poll's existing options on the recipient's device when the update is sent. Omitting an existing option returns 400.

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

Request

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

Path parameters

messageIdstring uuid required
Example:69a37c7d-af4f-4b5e-af42-e28e98ce873a

The poll-definition message's ID (returned by create)

Request body

Example request

{
  "options": [
    {
      "text": "Tacos"
    }
  ]
}

Response

Options added

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.