Current section
Files
Jump to
Current section
Files
priv/docs/methods/usergroups.disable.json
{
"args": {
"include_count": {
"desc": "Include the number of users in the User Group.",
"example": "true",
"required": false,
"type": "boolean"
},
"team_id": {
"desc": "Encoded target team id where the user group is, required if org token is used.",
"required": false
},
"usergroup": {
"desc": "The encoded ID of the User Group to disable.",
"example": "S0604QSJC",
"required": true
}
},
"desc": "Disable an existing User Group.",
"errors": {
"missing_argument": "A required argument is missing.",
"permission_denied": "The user does not have permission to disable the 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"
}
]
}
}