Update Channels

Use channel updates when the app needs to change channel attributes after creation. Keep updates narrow: send only fields that actually changed, because metadata and tag updates replace the submitted values rather than merging app-side state for you.

Update Surface

Field	TypeScript	iOS	Android	Flutter
Display name	`displayName`	`setDisplayName(...)`	`.displayName(...)`	`.displayName(...)`
Avatar	`avatarFileId`	`setAvatar(...)`	`.avatar(...)`	`.avatar(...)`
Tags	`tags`	`setTags(...)`	`.tags(...)`	`.tags(...)`
Metadata	`metadata`	`setMetadata(...)`	`.metadata(...)`	`.metadata(...)`
Notification mode	`notificationMode`	`setNotificationMode(_:)` on `AmityChannelUpdateOptions`	`.notificationMode(...)` on the edit builder	`.notificationMode(...)`

Parameters

Parameter	Required	Platforms	Description
`channelId`	Yes	TypeScript, iOS, Android, Flutter	Channel ID to update.
`displayName`	No	TypeScript, iOS, Android, Flutter	Replacement channel display name.
`avatarFileId` / `avatar`	No	TypeScript, iOS, Android, Flutter	Replacement avatar file reference where supported.
`tags`	No	TypeScript, iOS, Android, Flutter	Replacement tag list for the channel.
`metadata`	No	TypeScript, iOS, Android, Flutter	Replacement metadata stored with the channel.
`notificationMode`	No	TypeScript, iOS, Android, Flutter	Per-channel notification mode: `default`, `silent`, or `subscribe`. Exposed on all four platforms.

Update Channel Fields

Update channel profile fields such as display name, avatar, tags, or metadata where the platform exposes those setters.

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

const { data: updatedChannel } = await ChannelRepository.updateChannel(
  channelId,
  {
    displayName: 'Support desk',
    tags: ['support', 'active'],
    metadata: {
      queue: 'tier-2',
    },
  },
);

renderResults(updatedChannel);

let options = AmityChannelUpdateOptions(channelId: "channel-id")
options.setDisplayName("Support desk")
options.setTags(["support", "active"])
options.setMetadata(["queue": "tier-2"])

let channel = try await channelRepository.editChannel(with: options)
showSuccessMessage(channel.channelId)

val metadata = JsonObject().apply {
    addProperty("queue", "tier-2")
}

val disposable = channelRepository
    .editChannel(channelId = channelId)
    .displayName("Support desk")
    .tags(AmityTags(listOf("support", "active")))
    .metadata(metadata)
    .build()
    .apply()
    .subscribe(
        { channel -> showSuccessMessage(channel.getChannelId()) },
        { error -> handleGeneralError(error) },
    )

final channel = await AmityChatClient.newChannelRepository()
    .updateChannel(channelId)
    .displayName('Support desk')
    .tags(['support', 'active'])
    .metadata({'queue': 'tier-2'})
    .create();

final updatedChannelId = channel.channelId;

Update Notification Mode

The channel update API exposes notification mode on all four platforms. The available values are default, silent, and subscribe. Use the dedicated channel notification settings for broader notification configuration.

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

const { data: channel } = await ChannelRepository.updateChannel(
  channelId,
  {
    notificationMode: AmityChannelNotificationModeEnum.Silent,
  },
);

renderResults(channel);

let options = AmityChannelUpdateOptions(channelId: "channel-id")
options.setNotificationMode(.silent)

let channel = try await channelRepository.editChannel(with: options)
showSuccessMessage(channel.channelId)

val disposable = channelRepository
    .editChannel(channelId = channelId)
    .notificationMode(AmityChannelNotificationMode.SILENT)
    .build()
    .apply()
    .subscribe(
        { channel -> showSuccessMessage(channel.getChannelId()) },
        { error -> handleGeneralError(error) },
    )

final channel = await AmityChatClient.newChannelRepository()
    .updateChannel(channelId)
    .notificationMode(NotificationMode.silent)
    .create();

final notificationMode = channel.notificationMode;

Get Channels

Observe the updated channel object.

Query Channels

Refresh channel lists after an update.

Channel Notifications

Configure channel notification settings.

Member Management

Manage membership separately from channel attributes.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Update Surface

Parameters

Update Channel Fields

Update Notification Mode

Get Channels

Query Channels

Channel Notifications

Member Management

​Update Surface

​Parameters

​Update Channel Fields

​Update Notification Mode

​Related Topics

Get Channels

Query Channels

Channel Notifications

Member Management

Update Surface

Parameters

Update Channel Fields

Update Notification Mode

Related Topics