This is reference content about building functions and workflows. Learn more if you're not yet familiar with this new Slack platform paradigm.
View all Slack functions

invite_user_to_channel

Invite someone to a channel.

Facts

Schema ID

Schema.slack.functions.InviteUserToChannel

Schema reference

slack#/functions/invite_user_to_channel

Required scopes

channels:managegroups:write

Input parameters

Required parameters
user_ids
Schema.types.array
·Required
A list of user ID(s) to add to the conversation.
  • ["U12Z4A6","UZ3122356"]
Optional parameters

Output parameters

Required parameters
user_ids
Schema.types.array
·Required
A list of user ID(s) to added to the conversation.
  • ["U12Z4A6","UZ3122356"]
Optional parameters

Usage guide

This function allows your workflow to add users to a channel. It only works with channels your workflow created.

Example workflow step

const inviteUserToChannelStep = ExampleWorkflow.addStep(
  Schema.slack.functions.InviteUserToChannel,
  {
    channel_ids: ["C082T4F6S1N"],
    user_ids: ["U0R36M8T62", "U0J46F228L0"],
  },
);