Skip to main content

@wildix/xbees-conversations-client > TagChannelInput

TagChannelInput interface

Signature:

export interface TagChannelInput 

Properties

Property

Modifiers

Type

Description

channelId

string

The unique identifier of the channel whose messages are to be marked as unread.

force?

boolean | undefined

(Optional) A flag that indicates whether the system should replace the oldest tagged channel with a new one if the limit of tagged channels is reached. If the force option is specified as false and the user already has the maximum limit of tagged channels for the tag, then the system will respond with an error.

tagId

string

The unique identifier of the tag to add to the channel.

userId?

string | undefined

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