Skip to main content
Chat / Platform API
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Channel

    Decline an invitation

    Declines an invitation for a user to not join a group channel. See this page to learn more about channel types.

    Note: This action is available only when the auto_accept property of an application is set to false. You can change the value of the property using the update default channel invitation preference action, or the update channel invitation preference action.

    HTTP request

    PUT https://api-{application_id}.sendbird.com/v3/group_channels/{channel_url}/decline

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of the group channel.

    Request body

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

    Required
    Property nameTypeDescription

    user_id

    string

    Specifies the unique ID of the user.

    Response

    If successful, this action returns an empty response body.

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