Skip to main content
PUT
update a channel

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

channelId
string
required

Body

application/json

Information of channel to be updated

displayName
string
Maximum string length: 100
avatarFileId
string
Maximum string length: 50
metadata
object
tags
string[]
Maximum array length: 10
Maximum string length: 100
messageAutoDeleteEnabled
boolean
autoDeleteMessageByFlagLimit
number
Required range: 1 <= x <= 1000
notificationMode
enum<string>

Notification Mode:

  • default - Auto register push notification.
  • silent - Do not send notification.
  • subscribe - Send notification to subscribed users only.
Available options:
default,
silent,
subscribe

Response

Channels Information

channels
object[]
channelUsers
object[]

List of users in channel with membership and role. Normally, it will return only caller as user. However, it will return all users in conversation channel. For ban/unban events, it will return banned users.

messagePreviews
object[]

Depends on messagePreviewId. if null will be empty array.

messageFeedsInfo
object[]

Depends on messagePreviews. if empty array will be empty array.

users
object[]
files
object[]