The Polls feature provides a comprehensive API that enables seamless integration of polling capabilities within your application, enhancing engagement and interaction among users. Through this API, developers can effortlessly create, manage, and utilize polls as part of messages, gather user opinions, and make informed decisions based on real-time feedback.

• Easy Poll Creation and Configuration: Developers can create polls with customizable options, descriptions, and configurations, including setting voting visibility (public or anonymous), enforcing unique votes, and specifying the maximum votes a user can cast. Polls can also be designed to allow user-suggested options or open-ended answers, providing flexibility in how you engage with your audience.

• Seamless Integration with Messages: Once created, polls can be sent as part of messages, allowing for a seamless user experience. Users can view poll details and participate directly within the context of a conversation.

• Dynamic Poll Management: Polls are not static. You can update poll details, add or modify options, and even close polls to further responses. These actions can be performed through full or partial updates, giving you control over the poll's lifecycle.

• Robust Voting System: Users can cast votes on options or provide answers to open-ended questions, with the API supporting both single and multiple choice responses. Votes can be changed or removed, ensuring users' opinions are accurately captured.

• Comprehensive Query Capabilities: Retrieve detailed information about polls and votes based on various criteria, including poll status, creation time, and user responses. This enables developers to implement rich, data-driven features in their applications.

• Customizability and Extensibility: In addition to predefined poll properties, the API supports custom properties, allowing developers to tailor polls and options to their specific needs while maintaining performance and scalability.

Creating a poll is easy. You simply create a poll with your desired configuration, and once created, you send a message with the poll id.

When creating a poll, the following properties can be configured:

Besides the above mentioned properties, it is also possible to supply your own custom properties for both polls and options:

Once a poll has been send as part of a message (and as long as the poll isn’t closed for voting). Votes can be casted

• If enforce_unique_votes is set to true on poll, then any vote casted on option will replace the previous vote. Also this api will broadcast an event:

  • poll.vote_changed if enforce_unique_votes is true

  • Otherwise poll.vote_casted event will be broadcasted

• Adding an answer will always replace the previous answer. This ensures that user can add maximum 1 answer (similar to what Polly app has)

• You need CastVote permission to be able to cast a vote

• API will return an error if poll is not attached to a message.

A vote can be removed as well:

If you want to prevent any further votes on a poll, you can close a poll for voting:

If you know the id of a poll you can easily retrieve the poll by using the getPoll method. If you don’t know the id or if you want to retrieve multiple polls, use the query polls method (see below)

There are two ways to update a poll: a full poll update and a partial update.

Deleting a poll removes the poll, its associated options as well as all the votes on that poll. Be aware that removing a poll can’t be undone.

Poll options can be added, updated or deleted after a poll has been created:

You are able to query the votes on a poll:

It is also possible to query for polls based on certain filter criteria:

The following websocket events will be emitted:

• poll.updated whenever a poll (or its options) gets updated.

• poll.closed whenever a poll is closed for voting.

• poll.deleted whenever a poll gets deleted.

• poll.vote_casted whenever a vote is casted.

• poll.vote_removed whenever a vote is removed.

• poll.vote_changed whenever a vote is changed (case of enforce_unique_vote as true)