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

    Update default invitation preference

    You can update the default channel invitation preference of an application using this API. Updating the default channel invitation preference won't override existing users' individual channel invitation preferences. The changed preference only affects users created after the update. To update a particular user's channel invitation preference, see update channel invitation preference.


    HTTP request

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

    Request body

    The following table lists the properties of an HTTP request that this action supports.

    Required
    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)


    Responses

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

    {
        "auto_accept": true
    }
    

    Error

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
        "message": "\"auto_accept\" must be a boolean.",
        "code": 400104,
        "error": true
    }