Skip to main content

A user's membership record in a messaging channel, including notification preferences and read state.

​
id
string
required

The unique identifier for the entity

​
user_id
string
required

The unique identifier of the user who holds this channel membership.

​
channel_id
string
required

The unique identifier of the messaging channel this membership belongs to.

​
status
enum<string>
required

The current state of this membership: requested, accepted, hidden, closed, or archived.

Available options:
requested,
accepted,
hidden,
closed,
archived
​
last_viewed_at
string | null
required

The timestamp when this member last viewed the channel, as a Unix timestamp in milliseconds. Null if the member has never viewed the channel.

Example:

"123.45"

​
notification_preference
enum<string>
required

The notification level for this channel: all, mentions, or none.

Available options:
all,
mentions,
none