Skip to main content

removeChannelMember

Remove a member from a channel. Requires the 'manage_members' channel permission, except that any member may remove themselves. Notifies Buddy to stop routing to the removed member. Returns true if a membership was removed.

removeChannelMember(
  groupId: BigInt!
  userId: BigInt!
): Boolean!

Arguments​

removeChannelMember.groupId ● BigInt! non-null scalar​

The channel to remove the user from.

removeChannelMember.userId ● BigInt! non-null scalar​

The user to remove (may be the caller's own id to self-remove).

Type​

Boolean scalar​

The Boolean scalar type represents true or false.