Update the list of users for a user group.
POSThttps://slack.com/api/usergroups.users.update
application/x-www-form-urlencoded
application/json
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxx
This method updates the list of users that belong to a user group. It replaces all users in a user group with the list of users provided in the users
parameter.
In order to call this method successfully, you'll need to ensure that your workspace settings allow you to manage user groups; otherwise you will receive a permission_denied
error.
To update this setting, navigate to Tools & settings > Workspace settings > Permissions > User Groups within your workspace and update who can create, disable, or modify user groups from the drop-down menus.
If user group permissions cannot be changed and are restricted to admins only, use the user token from a user with the correct permissions. A bot token can be used only if permissions are set to everyone
.
You cannot use this method to remove all members from a user group. Instead, use the usergroups.disable
method. If you need to reactivate the user group later, use the usergroups.enable
method.
Guests or bot users cannot be added to user groups; attempting to do so will result in an invalid_user
error (or in the case of single channel guests, a single_channel_guests_cannot_be_added
error).
The team_id
is only relevant when using an org-level token. This field will be ignored if the API call is sent using a workspace-level token.
As outlined in Using the Slack Web API, you may present your arguments as either standard POST parameters, or you may use JSON. This can be confusing in terms of the array argument type (users
), so let's clarify: to call the method with a URL-encoded string, it may look something like this:
users=U0130R122E8%2C%20U0133AHT0M8
while calling it with a JSON body should be formatted as follows:
"users": [
"U0130R122E8",
"U0133AHT0M8"
]
Both will yield the same result, so it's potato, po-tah-to as far as we're concerned.
Typical success response
{
"ok": true,
"usergroup": {
"id": "S0616NG6M",
"team_id": "T060R4BHN",
"is_usergroup": true,
"name": "Marketing Team",
"description": "Marketing gurus, PR experts and product advocates.",
"handle": "marketing-team",
"is_external": false,
"date_create": 1447096577,
"date_update": 1447102109,
"date_delete": 0,
"auto_type": null,
"created_by": "U060R4BJ4",
"updated_by": "U060R4BJ4",
"deleted_by": null,
"prefs": {
"channels": [],
"groups": []
},
"users": [
"U060R4BJ4",
"U060RNRCZ"
],
"user_count": 1
}
}
Typical error response
{
"ok": false,
"error": "invalid_auth"
}
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
invalid_users | Value passed for |
failed_for_some_users | User(s) are not in the workspace where this usergroup exists |
missing_argument | A required argument is missing. |
no_users_provided | Either the |
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. |
access_denied | Access to a resource specified in the request is denied. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
deprecated_endpoint | The endpoint has been deprecated. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
is_bot | This method cannot be called by a legacy bot. |
user_is_restricted | This method cannot be called by a restricted user or single channel guest. |
method_deprecated | The method has been deprecated. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
not_allowed_token_type | The token type used in this request is not allowed. |
not_authed | No authentication token provided. |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
token_expired | Authentication token has expired |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
two_factor_setup_required | Two factor setup is required. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
accesslimited | Access to this method is limited on the current network |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |