invite_user_to_channel

Facts

Description

Schema

Schema reference

Required scopes

No additional scopes required

Input Parameters

Output Parameters

Usage info

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

You can provide the usergroup_ids or user_ids parameters.

Example workflow step

const inviteUserToChannelStep = ExampleWorkflow.addStep(
  Schema.slack.functions.InviteUserToChannel,
  {
    channel_ids: ["C0123ABC456"],
    user_ids: ["U111AAA111", "UZZZ999ZZZ"],
  },
);