Ban Management

Use channel bans when a member should lose access to a specific chat channel until a moderator restores access. The SDK operation is per-channel; ban reasons, appeal flows, and moderation audit logs are app-owned product logic.

Platform Surface

Operation	TypeScript	iOS	Android	Flutter
Ban members	`ChannelRepository.Moderation.banMembers(channelId, userIds)`	`AmityChannelModeration(channelId:).banMembers(_:)`	`moderation(channelId).banMembers(userIds)`	`moderation(channelId).banMembers(userIds)`
Unban members	`ChannelRepository.Moderation.unbanMembers(channelId, userIds)`	`AmityChannelModeration(channelId:).unbanMembers(_:)`	`moderation(channelId).unbanMembers(userIds)`	`moderation(channelId).unbanMembers(userIds)`
Result	Cached channel memberships	`Void`	`Completable`	`Future`

Parameters

Parameter	Required	Description
`channelId`	Yes	Channel ID where the ban or unban should be applied.
`userIds`	Yes	One or more user IDs to ban or unban. Empty lists are rejected.
Moderation permission	Yes	The current user must have permission to moderate the target channel.

Ban Members

Ban removes the users from channel participation and prevents them from rejoining until they are unbanned.

import { ChannelRepository } from '@amityco/ts-sdk';

const banned = await ChannelRepository.Moderation.banMembers(channelId, [
  userId,
]);

renderResults(banned.data);

let moderation = AmityChannelModeration(channelId: channelId)

try await moderation.banMembers([userId])

showSuccessMessage(channelId)

val disposable = channelRepository
    .moderation(channelId = channelId)
    .banMembers(userIds = listOf(targetUserId))
    .subscribe(
        { showSuccessMessage(channelId) },
        { error -> handleGeneralError(error) },
    )

await AmityChatClient.newChannelRepository()
    .moderation(channelId)
    .banMembers([targetUserId]);

Unban Members

Unban restores the users to the channel’s allowed membership state. If your app shows a ban list, refresh that list after the operation succeeds.

import { ChannelRepository } from '@amityco/ts-sdk';

const unbanned = await ChannelRepository.Moderation.unbanMembers(channelId, [
  userId,
]);

renderResults(unbanned.data);

let moderation = AmityChannelModeration(channelId: channelId)

try await moderation.unbanMembers([userId])

showSuccessMessage(channelId)

val disposable = channelRepository
    .moderation(channelId = channelId)
    .unbanMembers(userIds = listOf(targetUserId))
    .subscribe(
        { showSuccessMessage(channelId) },
        { error -> handleGeneralError(error) },
    )

await AmityChatClient.newChannelRepository()
    .moderation(channelId)
    .unbanMembers([targetUserId]);

Implementation Notes

Permission Checks

The SDK call can fail when the current user cannot moderate the channel or the target user cannot be moderated. Handle permission and validation errors in your UI.

Channel Scope

A channel ban applies to the target channel. It is not a global user block and does not replace user-level block or content flag workflows.

Product Policy

Store ban reasons, moderator notes, appeal state, or compliance records in your own system if your product requires them.

Member Lists

Query channel members with banned-membership filters when you need to render a ban list or confirm current ban state.

Query Members

Filter channel members by membership state.

Mute Management

Temporarily restrict message sending.

Member Management

Add or remove channel members.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Platform Surface

Parameters

Ban Members

Unban Members

Implementation Notes

Permission Checks

Channel Scope

Product Policy

Member Lists

Query Members

Mute Management

Member Management

​Platform Surface

​Parameters

​Ban Members

​Unban Members

​Implementation Notes

Permission Checks

Channel Scope

Product Policy

Member Lists

​Related Topics

Query Members

Mute Management

Member Management

Platform Surface

Parameters

Ban Members

Unban Members

Implementation Notes

Related Topics