Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    Get a poll

    This action retrieves information on a specific poll.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/polls/{poll_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    poll_id

    integer

    Specifies the unique ID of the poll.


    Request body

    The following table lists the properties that this action supports.

    Optional
    Property nameTypeDescription

    channel_url

    string

    Specifies the URL of the channel. If channel_type is specified, channel_url must be specified as well.

    channel_type

    string

    Specifies the type of the channel. Acceptable values are open_channels and group_channels, but polls are only available in group_channels. If channel_url is specified, channel_type must be specified as well.

    show_partial_voter_list

    boolean

    Determines whether to show a partial list of voters for each option. If set to true, the option resources inside the response include the partial_voter_list property which shows up to ten voters. (Default: false)


    Response

    If successful, this action returns a poll resource in the response body.

    In the case of an error, an error object is returned. A detailed list of error codes is available here.