Membership object

Membership is an object that refers to a single user-channel relation in a chat.


The Membership object has the following properties:

class Membership {
channel: Channel,
user: User,
custom: ObjectCustom
channelChannelChannel object.
userUserUser object.
customObjectCustomAny custom properties or metadata associated with the channel-user membership, such as lastReadMessageTimetoken.
API limits

To learn about the maximum length of parameters used to set channel membership metadata, refer to REST API docs.


You can call the following methods on the Membership object.

Click on each method for more details.

Use case

For example, you can use the Membership object methods to:

Last updated on