Slack

v0.23.5

Slack v0.23.5 Slack.Web.Usergroups View Source

Link to this section Summary

Functions

create(name, optional_params \\ %{})

Create a user group

disable(usergroup, optional_params \\ %{})

Disable an existing user group

enable(usergroup, optional_params \\ %{})

Enable a user group

list(optional_params \\ %{})

List all user groups for a team

update(usergroup, optional_params \\ %{})

Update an existing user group

Link to this section Functions

Link to this function

create(name, optional_params \\ %{}) View Source

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
Link to this function

disable(usergroup, optional_params \\ %{}) View Source

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
Link to this function

enable(usergroup, optional_params \\ %{}) View Source

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
Link to this function

list(optional_params \\ %{}) View Source

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
Link to this function

update(usergroup, optional_params \\ %{}) View Source

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