Skip to main content
Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API

    View channel invitation preference

    Retrieves a user's group channel invitation preference. See this page to learn more about channel types.

    Note: Users are subject to both user-specific and channel-wide invitation preferences. Of the two, the invitation preference set for a specific user takes precedence over the default channel invitation preference.

    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/users/{user_id}/channel_invitation_preference

    Response

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

    {
    "auto_accept": true
}

    List of response properties

    Property nameTypeDescription

    auto_accept

    boolean

    Indicates for the user whether or not to automatically join a group channel promptly from an invitation without having to accept it. The value of false indicates that users can accept or decline an invitation to join a group channel. (Default: true)

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