Chat / Platform API
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    Close a poll

    This action closes a poll and prevents users from voting any further.


    HTTP request

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

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    poll_id

    integer

    Specifies the unique ID of the poll.


    Response

    If successful, this action returns a poll resource with its updated status in the response body.

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