Member Management

Use member management when your app needs to add users to a channel or remove users from a channel. Channel type, membership rules, and moderator permissions can still determine whether a request is accepted by the server.

Platform Surface

Operation	TypeScript	iOS	Android	Flutter
Add members	`ChannelRepository.Membership.addMembers(channelId, userIds)`	`AmityChannelMembership(channelId:).addMembers(_:)`	`membership(channelId).addMembers(userIds)`	`addMembers(channelId, userIds)`
Remove members	`ChannelRepository.Membership.removeMembers(channelId, userIds)`	`AmityChannelMembership(channelId:).removeMembers(_:)`	`membership(channelId).removeMembers(userIds)`	`removeMembers(channelId, userIds)`
Result	`Promise<boolean>`	`Void`	`Completable`	`Future`

Parameters

Parameter	Required	Description
`channelId`	Yes	Channel ID whose membership should change.
`userIds`	Yes	One or more user IDs to add or remove. Empty lists are rejected.
Membership permission	Yes	The current user must be allowed to manage members for the target channel.

Add Members

Add members when an existing channel should include additional users. For conversation channels, prefer the conversation creation APIs when creating the conversation membership for the first time.

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

const didAdd = await ChannelRepository.Membership.addMembers(channelId, [
  userId,
]);

if (didAdd) {
  showSuccessMessage(channelId);
}

let membership = AmityChannelMembership(channelId: channelId)

try await membership.addMembers([userId])

showSuccessMessage(channelId)

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

await AmityChatClient.newChannelRepository()
    .addMembers(channelId, [targetUserId]);

Remove Members

Remove members when users should no longer participate in the channel. If the user is currently viewing the channel, update the route or composer state after removal succeeds.

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

const didRemove = await ChannelRepository.Membership.removeMembers(channelId, [
  userId,
]);

if (didRemove) {
  showSuccessMessage(channelId);
}

let membership = AmityChannelMembership(channelId: channelId)

try await membership.removeMembers([userId])

showSuccessMessage(channelId)

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

await AmityChatClient.newChannelRepository()
    .removeMembers(channelId, [targetUserId]);

Implementation Notes

Bulk Input

All platforms accept a list of user IDs, so use one call for a small batch instead of looping one user at a time.

Channel Rules

Some channel types or roles can reject member changes. Treat failures as server authority, not as local state to override.

Current User

Use join and leave APIs when the current user is entering or exiting a channel themselves.

Member State

Query members after add or remove operations when your UI needs confirmed membership, role, or banned-state data.

Join and Leave

Let the current user join or leave a channel.

Query Members

Retrieve and filter channel membership.

Role Management

Assign channel roles to members.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Platform Surface

Parameters

Add Members

Remove Members

Implementation Notes

Bulk Input

Channel Rules

Current User

Member State

Join and Leave

Query Members

Role Management

​Platform Surface

​Parameters

​Add Members

​Remove Members

​Implementation Notes

Bulk Input

Channel Rules

Current User

Member State

​Related Topics

Join and Leave

Query Members

Role Management

Platform Surface

Parameters

Add Members

Remove Members

Implementation Notes

Related Topics