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

    Get channel invitation preference

    This action retrieves a user's group channel invitation preference. Users are subject to both user-specific and application-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
    

    Responses

    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 whether a user will automatically join a group channel without having to manually accept an invitation. If set to false, the user must choose to accept or decline the invitation to join a group channel. (Default: true)

    Error

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

    {
        "message": "\"User\" not found.",
        "code": 400201,
        "error": true
    }