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


Add a user to a user group


Schema ID


Schema reference


Required scopes

Input parameters

Required parameters
The ID for the user group to add the user to
  • S123ABC456
A list of user IDs to add to the User Group
  • ["U111AAA111","U222BBB222"]
Optional parameters

Output parameters

Optional parameters
The ID for the user group that now contains the added user(s)
  • S123ABC456

Usage guide

Your workspace has user groups and you want to automate adding users to them in workflows? This function is here to make your user groups grow!

Example workflow step

Here is an example of how to use this function in a workflow step.

// TypeScript

const addUserToUsergroupStep = ExampleWorkflow.addStep(
    usergroup_id: "S04UZRV61T8",
    user_ids: ["U0R36M8T62", "U0J46F228L0"],