/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Add a poll option

    Copy link

    This action adds a new option to a poll.


    HTTP request

    Copy link
    POST https://api-{application_id}.sendbird.com/v3/polls/{poll_id}/options
    

    Parameters

    Copy link

    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

    Copy link

    The following table lists the properties that this action supports.

    Properties
    RequiredTypeDescription

    text

    string

    Specifies the description of a new option. The maximum length is 2,000 characters.

    OptionalTypeDescription

    created_by

    string

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


    Response

    Copy link

    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.