channels

View channel

Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.

post/api/v4/channels/members/{user_id}/view

Path parameters

user_idstring required

User ID to perform the view action for

Request body

channel_idstring required

The channel ID that is being viewed. Use a blank string to indicate that all channels have lost focus.

prev_channel_idstring

The channel ID of the previous channel, used when switching channels. Providing this ID will cause push notifications to clear on the channel being switched to.

Example request

{
  "channel_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "prev_channel_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Response

Channel view successful

statusstring

Value should be "OK" if successful

last_viewed_at_timesobject

A JSON object mapping channel IDs to the channel view times

Changes

No recorded changes to this endpoint across all 1 revision of this API.