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


Remove a user from a user group


Schema ID


Schema reference


Required scopes

Input parameters

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

Output parameters

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

Usage guide

Users have different needs and different teams over time. Sometimes you want to automate removing users from user groups.

Example workflow step:

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