Skip to main content

deleteChannelRole

Delete a non-system channel role. Requires the 'manage_roles' channel permission (app admins bypass). The system 'leader' role cannot be deleted. DESTRUCTIVE: removes the role from members. Returns true if a role was deleted.

deleteChannelRole(
  groupRoleId: BigInt!
): Boolean!

Arguments​

deleteChannelRole.groupRoleId ● BigInt! non-null scalar​

The channel role to delete (must be a non-system role).

Type​

Boolean scalar​

The Boolean scalar type represents true or false.