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

    Update count preference of a channel

    This action updates a user's count preference of a specific group channel. The count preference allows a user to either update the number of unread messages or the number of unread mentioned messages, or both in a specific group channel.

    If you want to retrieve the total number count of a specific group channel, go to the get count preference of a channel page.


    HTTP request

    PUT https://api-{application_id}.sendbird.com/v3/users/{user_id}/count_preference/{channel_url}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    user_id

    string

    Specifies the unique ID of a user.

    channel_url

    string

    Specifies the URL of a group channel.


    Request body

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

    Required
    Property nameTypeDescription

    count_preference

    string

    Determines whether to only count the number of unread messages or unread mentioned messages in the specified group channel. Only the preferred unread item is counted and added to the total number count. Acceptable values are the following:
    - off: Determines that neither of unread statuses are counted.
    - all: Determines that both unread statuses are counted.
    - unread_message_count_only: Determines that only the user's unread messages are counted.
    - unread_mentioned_count_only: Determines that only the user's unread mentioned messages are counted. (Default: all)


    Responses

    If successful, this action returns a user's updated count preference of a group channel in the response body.

    {
      "count_preference": "unread_message_count_only"
    }
    

    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
    }