slack_kit

{
  "args": {
    "additional_channels": {
      "desc": "A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.",
      "required": false,
      "type": "array"
    },
    "channels": {
      "desc": "A comma separated string of encoded channel IDs for which the User Group uses as a default.",
      "required": false,
      "type": "array"
    },
    "description": {
      "desc": "A short description of the User Group.",
      "required": false,
      "type": "string"
    },
    "enable_section": {
      "desc": "Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.",
      "example": "true",
      "required": false,
      "type": "boolean"
    },
    "handle": {
      "desc": "A mention handle. Must be unique among channels, users and User Groups.",
      "required": false,
      "type": "string"
    },
    "include_count": {
      "desc": "Include the number of users in the User Group.",
      "example": "true",
      "required": false,
      "type": "boolean"
    },
    "name": {
      "desc": "A name for the User Group. Must be unique among User Groups.",
      "example": "My Test Team",
      "required": false,
      "type": "string"
    },
    "team_id": {
      "desc": "encoded team id where the user group exists, required if org token is used",
      "required": false
    },
    "usergroup": {
      "desc": "The encoded ID of the User Group to update.",
      "example": "S0604QSJC",
      "required": true
    }
  },
  "desc": "Update an existing User Group.",
  "errors": {
    "missing_argument": "A required argument is missing.",
    "paid_teams_only": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.",
    "permission_denied": "The user does not have permission to update the User Group.",
    "too_many_linked_channels": "This request exceeds the number of channels we supporting linking to a single usergroup."
  },
  "rate_limit": {
    "label": "Tier 2: 20+ per minute",
    "url": "https://docs.slack.dev/apis/web-api/rate-limits"
  },
  "scopes": {
    "bot": [
      {
        "name": "usergroups:write",
        "url": "https://docs.slack.dev/reference/scopes/usergroups.write"
      }
    ],
    "user": [
      {
        "name": "usergroups:write",
        "url": "https://docs.slack.dev/reference/scopes/usergroups.write"
      }
    ]
  }
}