ChannelCreateRequest
ChannelCreateRequest =
object
Request object for creating a new channel within a channel group.
Properties
accessRuleCreates?
optionalaccessRuleCreates:AccessRuleCreateRoleOrMemberRequest[]
Optional array of AccessRuleCreateRoleOrMemberRequest objects to define initial access rules for the channel. Each rule specifies a role or member and optional permission overlays.
channelGroupId
channelGroupId:
ChannelGroupGuid
The ID of the channel group where the channel will be created. Required.
channelType
channelType:
number
The type of channel to create. Required. Use the ChannelType enum values: Text (1), ThreadedText (2), Voice (4), or App (8).
description?
optionaldescription:string
Optional description for the channel.
iconTokenUri?
optionaliconTokenUri:string
Optional token URI for the channel icon. Obtain this value from the asset upload process.
name
name:
string
The display name for the new channel. Required.
useChannelGroupPermission
useChannelGroupPermission:
boolean
When true, the channel inherits permissions from its parent channel group. When false, the channel uses its own permission rules defined by access rules. Required.