Skip to main content
POST
Mark Channel Read

Authorizations

Authorization
string
header
required

An App API key or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-07"

Path Parameters

id
string
required

Public resource ID.

Body

application/json
last_viewed_at
string<date-time>

Required for DM-backed kinds; not accepted for experience.

Example:

"2026-01-01T12:00:00.000Z"

viewed_message_ids
string[]

Messages actually seen in this channel. Optional for all channel kinds; up to 100 IDs. Omitted or empty records no message views. Experience view counts update asynchronously.

Maximum array length: 100

Response

operation completed

channel_id
string
required
Example:

"feed_xxxxxxxxxxxxxxxxxxxxxx"

created_at
string | null
required

When the stored channel membership was created, as an ISO 8601 timestamp. Null for users whose access does not have a stored membership.

Example:

"2026-01-01T12:00:00.000Z"

id
string | null
required

Stored membership ID, or null for access-derived users.

Example:

"memb_1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

inbox_status
enum<string> | null
required

Your private-channel inbox state; null for other users or channel kinds.

Available options:
requested,
accepted,
hidden,
null
Example:

"accepted"

last_viewed_at
string | null
required

Authorized participant read position. Community positions are visible only to the user themselves.

Example:

"2026-01-01T12:00:00.000Z"

notification_preference
enum<string> | null
required
Available options:
all,
mentions,
none,
null
Example:

"all"

pinned_position
integer | null
required
Example:

null

unread
boolean | null
required

Personal unread state; null for other users.

Example:

false

updated_at
string | null
required

When the stored channel membership last changed, as an ISO 8601 timestamp. Null for users whose access does not have a stored membership.

Example:

"2026-01-01T12:00:00.000Z"

user
object
required
user_id
string
required

User ID

Example:

"user_xxxxxxxxxxxxxx"