Skip to main content

banTeamMember

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

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

Arguments​

banTeamMember.groupId ● BigInt! non-null scalar​

The team to ban the user from.

banTeamMember.userId ● BigInt! non-null scalar​

The user to ban.

banTeamMember.reason ● String scalar​

Why, for the team 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.