Skip to main content
A person added to a private or support channel has a stored membership, with a read position and a notification preference. A person who reads a channel through their access to its experience or support inbox has no stored membership. Their id is null, and their read position is not shown. Use the Channel Members API to list or search the people in a channel and add someone to a private or support channel. You can also change your notification preference. Remove a member, or remove yourself to leave a channel.

​
Endpoints

​
Attributes

​
string | null
required
Stored membership ID, or null for access-derived users.
​
string
required
​
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.
​
string | null
required
Your inbox state for a private channel. null for other users and other channel kinds.Available options: requested, accepted, hidden
​
string | null
required
Authorized participant read position. Community positions are visible only to the user themselves.
​
string | null
required
Available options: all, mentions, none
​
integer | null
required
​
boolean | null
required
Your unread state for the channel. null for other users.
​
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.
​
object
required

Properties

​
string
required
User ID, prefixed user_.
​
string | null
required
Display name.
​
object
required
Avatar wrapper. Its url is always present, and is a generated placeholder when the user set no picture.

Properties

​
string
required
Avatar image URL. Always present. It is a generated placeholder when the user set no picture.
​
string
required
Public username.
​
string
required
User ID
ChannelMember