Rocket.Chat Extended icon

Rocket.Chat Extended

Extended Rocket.Chat operations: channels, messages, threads, reactions, file upload, and more

Actions53

Channel → Invite

AI-generated

Summary

Invite a user to a channel or private group

Inputs

  • channelType — Whether to target a public channel or a private group
  • specifyRoomManually — Whether to specify the room ID manually instead of selecting from the list
  • roomId (required) — The ID of the channel/group
  • specifyUserManually — Whether to specify the user ID manually instead of selecting from the list
  • userId (required) — The ID of the user

Output shape

a single invitation result object

Returns the invited user's data (e.g., user ID, name); errors are thrown and not swallowed

Examples

Example 1: Invite a user to a public channel using list selections

channelType = channel, specifyRoomManually = false, roomId selected from dropdown, specifyUserManually = false, userId selected from dropdown

Example 2: Invite a user to a private group using manual IDs

channelType = group, specifyRoomManually = true, roomId = , specifyUserManually = true, userId =

Example 3: Invite a user to a channel with manual room ID but dropdown for user

channelType = channel, specifyRoomManually = true, roomId = , specifyUserManually = false, userId selected from dropdown

Links

Discussion