Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods usergroups.create.json
Raw

priv/docs/methods/usergroups.create.json

{
"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 each 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": true,
"type": "string"
},
"team_id": {
"desc": "Encoded team id where the user group has to be created, required if org token is used.",
"required": false,
"type": "string"
}
},
"desc": "Create a User Group.",
"errors": {
"bad_handle": "Handle is invalid",
"description_too_long": "Given usergroup description is too long",
"forbidden_handle": "Handle is invalid",
"handle_already_exists": "Handle is already in use on this workspace",
"invalid_channel_provided": "An invalid channel ID was provided",
"invalid_group_provided": "An invalid group ID was provided",
"missing_argument": "A required argument is missing.",
"missing_subteam_name": "Subteam name is required",
"name_already_exists": "Name is already in use on this workspace",
"name_too_long": "Name too long.",
"paid_teams_only": "Usergroups can only be used on paid Slack teams",
"permission_denied": "The user does not have permission to create a User Group.",
"plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.",
"target_team_must_be_specified_in_org_context": "No target team was specified but the team in context is an org",
"target_team_not_on_org": "Target team specified is not on the org in context"
},
"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"
}
]
}
}