Current section
Files
Jump to
Current section
Files
priv/docs/methods/usergroups.users.update.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"
},
"include_count": {
"desc": "Include the number of users in the user group.",
"example": "true",
"required": false,
"type": "boolean"
},
"is_shared": {
"desc": "Boolean to identify if the API is getting called when a shared section is getting shared",
"required": false,
"type": "boolean"
},
"team_id": {
"desc": "encoded team id where the user group exists, required if org token is used",
"required": false,
"type": "string"
},
"usergroup": {
"desc": "The encoded ID of the user group to update.",
"example": "S0604QSJC",
"required": true,
"type": "string"
},
"users": {
"desc": "A comma separated string of encoded user IDs that represent the entire list of users for the user group.",
"example": "U060R4BJ4,U060RNRCZ",
"required": true,
"type": "array"
}
},
"desc": "Update the list of users for a user group.",
"errors": {
"failed_for_some_users": "User(s) are not in the workspace where this usergroup exists",
"invalid_users": "Value passed for `users` was empty or invalid.",
"missing_argument": "A required argument is missing.",
"no_users_provided": "Either the `users` field wasn't provided or an empty value was passed.",
"permission_denied": "The user does not have permission to update the list of users for a user group. Check workspace settings to confirm whether the calling user has permission.",
"plan_upgrade_required": "This workspace does not have access to user groups, as that feature is only available on Standard and above plans.",
"subteam_max_users_exceeded": "Exceeds maximum supported number of users per subteam."
},
"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"
}
]
}
}