Polls

Use poll() to send a poll with a title and a list of choices. Each choice can be a plain string or a PollChoiceInput object. Use option() when you want the explicit form.

import { poll, option } from "spectrum-ts";

// Variadic strings
await space.send(poll("Lunch?", "Pizza", "Sushi", "Tacos"));

// Or an array, optionally using option() for clarity
await space.send(poll("Lunch?", [
  option("Pizza"),
  option("Sushi"),
  option("Tacos"),
]));

Outbound polls always require a nonempty title.

Incoming poll shape

Incoming polls carry optional identity fields that some providers supply:

Field	Type	Description
`title`	`string \| undefined`	Display title. Omitted for native iMessage polls.
`pollMessageGuid`	`string \| undefined`	Stable poll identity (iMessage).
`options`	`{ title: string, optionIdentifier?: string }[]`	Poll choices. Native polls include `optionIdentifier`.
`change`	`"created" \| "optionAdded" \| undefined`	Present on definition snapshots, not on votes.

Poll responses arrive as poll_option content with selected: true or false. The nested poll retains the same identity fields. See Messages for narrowing on incoming votes. For iMessage-specific poll behavior — titleless snapshots, option identifiers, and vote correlation — see Native iMessage polls.

⌘I

Get started

Core concepts

Content

Providers

Advanced

Integrations

Best Practices

Troubleshooting

Incoming poll shape

​Incoming poll shape

Incoming poll shape