access?

ChannelAccess | undefined

(Optional) The access level of the channel.

broadcast?

boolean | undefined

(Optional) Indicates if the channel is broadcast-only. Default is false.

channelId?

string | undefined

(Optional) The unique identifier for the new group channel. If not provided, the system will generate one.

context?

ChannelContext | undefined

(Optional) An additional information that associated with this channel.

description?

string | undefined

(Optional) The description of the channel.

members?

(string)[] | undefined

(Optional) A list of user IDs to be added as members of the group channel.

membersToInvite?

(UserToInvite)[] | undefined

(Optional) A list of users to invite to the group channel, identified by their email addresses or phone numbers.

picture?

string | undefined

(Optional) The URL of the channel's picture.

pictureColor?

string | undefined

(Optional) The dominant color of the channel's picture, represented by a hex value.

subject?

string | undefined

(Optional) The subject of the channel.

userId?

string | undefined

(Optional) The unique identifier of the user when a service token is used.