Skip to Content
MosaicMosaicDocs
Tool Reference

ManageChannelParticipants

Add or remove members of an existing channel.

Starter documentation. Features and account details may differ from this deployment.

ManageChannelParticipants

Add or remove members of an existing channel. Requires the current user to be a channel member. Direct-message channels cannot change membership. The channel owner cannot be removed. Participants accept mosaic|<email> ids from ListTeamMembers or bare emails. Use add to invite people and remove to take them out. Use only when the user asks to change who is in a channel.

Parameters

ParameterTypeRequiredDescription
channelIdstringYesChannel id whose membership should change.
action"add" | "remove"YesMembership change to apply.
participantsstring[]YesPeople to add or remove, as mosaic|<email> ids or bare emails. Must not be empty.

On this page