Slack v0.10.0 Slack.Web.Usergroups
Summary
Functions
Create a user group
Disable an existing user group
Enable a user group
List all user groups for a team
Update an existing user group
List all users in a user group
Update the list of users for a user group
Functions
Create a user group
Required Params
name
- A name for the user group. Must be unique among user groups. ex:My Test Team
Optional Params
channels
- A comma separated string of encoded channel IDs for which the user group uses as a default.description
- A short description of the user group.handle
- A mention handle. Must be unique among channels, users and user groups.include_count
- Include the number of users in each user group. ex:1
Disable an existing user group
Required Params
usergroup
- The encoded ID of the user group to disable. ex:S0604QSJC
Optional Params
include_count
- Include the number of users in the user group. ex:1
Enable a user group
Required Params
usergroup
- The encoded ID of the user group to enable. ex:S0604QSJC
Optional Params
include_count
- Include the number of users in the user group. ex:1
List all user groups for a team
Optional Params
include_count
- Include the number of users in each user group. ex:1
include_disabled
- Include disabled user groups. ex:1
include_users
- Include the list of users for each user group. ex:1
Update an existing user group
Required Params
usergroup
- The encoded ID of the user group to update. ex:S0604QSJC
Optional Params
channels
- A comma separated string of encoded channel IDs for which the user group uses as a default.description
- A short description of the user group.handle
- A mention handle. Must be unique among channels, users and user groups.include_count
- Include the number of users in the user group. ex:1
name
- A name for the user group. Must be unique among user groups. ex:My Test Team
List all users in a user group
Required Params
usergroup
- The encoded ID of the user group to update. ex:S0604QSJC
Optional Params
include_disabled
- Allow results that involve disabled user groups. ex:1
Update the list of users for a user group
Required Params
usergroup
- The encoded ID of the user group to update. ex:S0604QSJC
users
- A comma separated string of encoded user IDs that represent the entire list of users for the user group. ex:U060R4BJ4,U060RNRCZ
Optional Params
include_count
- Include the number of users in the user group. ex:1