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

add_user_to_usergroup

Add a user to a user group

Facts

Schema ID

Schema.slack.functions.AddUserToUsergroup

Schema reference

slack#/functions/add_user_to_usergroup

Required scopes

usergroups:write

Related methods

usergroups.users.update

Input parameters

Required parameters
usergroup_id
Schema.slack.types.usergroup_id
·Required
The ID for the user group to add the user to
  • S0614TZR7
user_ids
Schema.types.array
·Required
A list of user IDs to add to the User Group
  • ["U12Z4A6","UZ3122356"]
Optional parameters

Output parameters

Optional parameters
usergroup_id
Schema.slack.types.usergroup_id
·Optional
The ID for the user group that now contains the added user(s)
  • S0614TZR7

Usage guide

Add user to user group

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 next-gen platform workflow step.

// TypeScript

const addUserToUsergroupStep = ExampleWorkflow.addStep(
  Schema.slack.functions.AddUserToUsergroup,
  {
    usergroup_id: "S04UZRV61T8",
    user_ids: ["U0R36M8T62", "U0J46F228L0"],
  },
);