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

    Update a poll option

    This action updates the content of a poll option. Voting for an option doesn't update the option.


    HTTP request

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

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    poll_id

    integer

    Specifies the unique ID of a poll that the option belongs to.

    option_id

    integer

    Specifies the unique ID of a poll option.


    Request body

    The following table lists the properties that this action supports.

    Optional
    Property nameTypeDescription

    text

    string

    Specifies a new description of the option. The length should be between 1 and 20 characters, inclusive.

    created_by

    string

    Specifies the unique ID of the user who creates the option.


    Response

    If successful, this action returns an updated 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.