Skip to main content

banChannelMember

Ban a user from a channel: their membership (or a new row, for someone not yet in it) becomes 'banned', their roles go, Buddy stops routing the channel to and from them, and joining, requesting to join and being added are refused with GROUP_MEMBER_BANNED until unbanChannelMember. Leaving or removing does not lift a ban. Requires the 'manage_members' channel permission (app admins bypass). Never the channel's owner, never yourself.

banChannelMember(
  groupId: BigInt!
  userId: BigInt!
  reason: String
): GroupMember!

Arguments​

banChannelMember.groupId ● BigInt! non-null scalar​

The channel to ban the user from.

banChannelMember.userId ● BigInt! non-null scalar​

The user to ban.

banChannelMember.reason ● String scalar​

Why, for the channel managers (at most 500 characters). Not shown to the banned user.

Type​

GroupMember object​

A user's membership in a group, including the roles assigned to them.