Skip to main content

remove_user_from_usergroup

Facts​

DescriptionRemove a user from a user group
SchemaSchema.slack.functions.RemoveUserFromUsergroup
Schema referenceslack#/functions/remove_user_from_usergroup
Required scopes
usergroups:write

Input Parameters​

Required Input Parameters

user_idsSchema.types.arrayRequired

A list of user IDs to remove from the User Group

Examples
["U111AAA111","U222BBB222"]
usergroup_idSchema.slack.types.usergroup_idRequired

The ID for the user group to remove the user from

Examples
S123ABC456

Output Parameters​

Optional Output Parameters

usergroup_idSchema.slack.types.usergroup_idOptional

The ID for the user group that now contains the removed user(s)

Examples
S123ABC456

Usage info​

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(
  Schema.slack.functions.RemoveUserFromUsergroup,
  {
    usergroup_id: "S0123ABC456",
    user_ids: ["U111AAA111", "UZZZ999ZZZ"],
  },
);