User

Mark all messages as read

Changed on

Mark all messages as read

This action marks all of a user's unread messages as read in certain group channels. If channels aren't specified, the user's unread messages in all group channels are marked as read.

https://sendbird.com/docs/chat/platform-api/v3/user/marking-messages-as-read/mark-all-of-a-users-messages-as-read#1-mark-all-of-a-user-s-messages-as-read

put/v3/users/{user_id}/mark_as_read_all

Request

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

Path parameters

user_idstring required

(Required)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Request body

channel_urlsstring[]

Specifies an array of one or more group channel URLs where unread messages need to be marked as read. If not specified, unread messages in all group channels a user joined are marked as read.

Response

Successful response

EmptyObjectResponse required

Changes

    • warning

      deleted the header request parameter Api-Token

    • info

      added the new optional header request parameter api-token

    • info

      the request property became optional

    • info

      the header request parameter Api-Token became optional