SEsendbird
User

View count preference of a channel

Changed on

View count preference of a channel

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

If you want to update the total number count of a specific group channel, visit the update count preference of a channel.

https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/get-count-preference-of-a-channel#1-get-count-preference-of-a-channel

get/v3/users/{user_id}/count_preference/{channel_url}

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

user_idstring required

(Required)

channel_urlstring required

(Required)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

count_preference'false' | 'all' | 'unread_message_count_only' | 'unread_mentioned_count_only'

Example response

{
  "count_preference": "false"
}

Changes

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • warning

      added the new all enum value to the response property for the response status

    • warning

      added the new false enum value to the response property for the response status

    • warning

      added the new unread_mentioned_count_only enum value to the response property for the response status

    • warning

      added the new unread_message_count_only enum value to the response property for the response status

    • info

      api operation id viewCountPreferenceOfChannelByUrl removed and replaced with viewCountPreferenceOfAChannel

    • info

      added the new optional header request parameter api-token

  • 135d8b0705d4Revision changes
    • info

      the header request parameter Api-Token became optional