Skip to main content

create_usergroup

Facts​

DescriptionCreate a new user group
SchemaSchema.slack.functions.CreateUsergroup
Schema referenceslack#/functions/create_usergroup
Required scopes
No additional scopes required

Input Parameters​

Required Input Parameters

usergroup_handleSchema.types.stringRequired

The @usergroup handle that will be used to address the group in conversation

Examples
tiger-team-money
nerf-herders
usergroup_nameSchema.types.stringRequired

The name of the user group to be created

Examples
Monetization Tiger Team
Scruffy-looking nerf-herders

Optional Input Parameters

team_idSlackTypes.team_idOptional

Select a team

Examples
T1234567890

Output Parameters​

Required Output Parameters

usergroup_idSchema.slack.types.usergroup_idRequired

The ID for the user group you just created

Examples
S123ABC456

Usage info​

Create a new user group. You can add members to it later.

Example workflow step​

const createUsergroupStep = ExampleWorkflow.addStep(
  Schema.slack.functions.CreateUsergroup,
  {
    usergroup_name: "Baking enthusiasts",
    usergroup_handle: "bakers",
  },
);