product:chat

Creates a new poll

post/polls

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/polls
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

allow_answersboolean

Indicates whether users can suggest user defined answers

allow_user_suggested_optionsboolean
config_keystring

Key of the moderation configuration to use. Server-side only.

config_teamstring

Team associated with the configuration. Server-side only.

customobject

Custom data for this object

descriptionstring

A description of the poll

enforce_unique_voteboolean

Indicates whether users can cast multiple votes

idstring
is_closedboolean

Indicates whether the poll is open for voting

max_votes_allowedinteger

Indicates the maximum amount of votes a user can cast

namestring required

The name of the poll

teamstring
user_idstring
voting_visibility'anonymous' | 'public'

Represents the visibility of votes in a poll.

Response

Successful response

durationstring required

Duration of the request in milliseconds

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property