channelId

string

The unique identifier of the channel which should be pinned.

force?

boolean

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

userId?

string

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