Channel members

Members can be added to a channel either when creating it or by using the addMembers method.

Message parameter

You can optionally include a message object to allow client-side SDKs to generate a system message. This feature is available for both adding and removing members.

Hide history

When members join a channel, you can specify whether they have access to the channel's history.

By default, new members can see the history. To hide it, set the hide_history parameter to true.

Custom data can be added at the channel member level. Ensure it does not exceed 5KB.

There is a soft cap of 3000 channel memberships per user. If your use case requires >3000 channel memberships per user, consider removing users from channels or using elevated permissions to allow a user to access channels without membership if your use case allows.

Remove channel members / Leave a channel

removeMembers method allows you to remove members from a channel.

Users can leave a channel without moderator-level permissions.

Ensure channel members have the Leave Own Channel permission enabled.

Using the addModerators method adds the given users as moderators (or updates their role to moderator if already members), while demoteModerators removes the moderator status.

The addModerators method adds specified users as moderators to a channel. If the users are already members, their role is upgraded to moderator.

The demoteModerators method removes the moderator role from specified users.

Channel members can be partially updated. Only custom data and channel roles are eligible for modification.

You can set or unset fields, either separately or in the same call.

The queryMembers endpoint enables listing and paginating channel members. It offers filtering options to efficiently retrieve member information. This feature is particularly useful when you need to search through or display a comprehensive overview of channel membership.

By default, members are ordered from oldest to newest and can be paginated using offset-based pagination or by the created_at or user_id fields.

While pagination by offset is the simplest to implement, it can lead to incorrect results if the list of members changes during pagination.

The recommended approach is to sort created_at or user_id for more reliable results.

Here’s some example of how you can query the list of members:

By default when query members does not have any filter and it will match all members on your channel.

The following fields can be used to filter channel members, along with any custom data associated with them: