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

    View default invitation preference

    Retrieves the default channel invitation preference of an application.

    Note: You can also retrieve the value of channel invitation preference on an individual user level. See view channel invitation preference for further information.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/applications/default_channel_invitation_preference
    

    Response

    If successful, this action returns the value of the default channel invitation preference of an application in the response body.

    {
        "auto_accept": true
    }
    
    Property nameTypeDescription

    auto_accept

    boolean

    Indicates for users within an application whether or not to automatically join a group channel promptly from an invitation without having to accept it. By default, invited users are automatically added as members to a group channel without the need to accept an invitation. If you would like to give users the option to decide whether to accept or decline an invitation to join a group channel, change the value to false. (Default: true)

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