Skip to main content

usergroups.users.update method

Facts​

DescriptionUpdate the list of users for a user group.
Method Access
POST https://slack.com/api/usergroups.users.update
Scopes
Content types
application/x-www-form-urlencoded
application/json
Rate LimitsTier 2: 20+ per minute

Arguments​

Required arguments

tokenstringRequired

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example: xxxx-xxxxxxxxx-xxxx
usergroupstringRequired

The encoded ID of the user group to update.

Example: S0604QSJC
usersarrayRequired

A comma separated string of encoded user IDs that represent the entire list of users for the user group.

Example: U060R4BJ4,U060RNRCZ

Optional arguments

include_countbooleanOptional

Include the number of users in the user group.

Example: true
team_idstringOptional

encoded team id where the user group exists, required if org token is used

additional_channelsarrayOptional

A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.

is_sharedbooleanOptional

Boolean to identify if the API is getting called when a shared section is getting shared

Usage info​

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.

POST Bodies​

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.

Response​

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"
}

Errors​

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 parameter in the response.

Error
Description
access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

Authentication token is for a deleted user or workspace when using a bot token.

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.

failed_for_some_users

User(s) are not in the workspace where this usergroup exists

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 _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_arguments

The method was called with invalid arguments.

invalid_array_arg

The method was passed an array as an argument. Please only input valid strings.

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.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

invalid_users

Value passed for users was empty or invalid.

method_deprecated

The method has been deprecated.

missing_argument

A required argument is missing.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

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.

no_users_provided

Either the users field wasn't provided or an empty value was passed.

not_allowed_token_type

The token type used in this request is not allowed.

not_authed

No authentication token provided.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

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.

ratelimited

The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

service_unavailable

The service is temporarily unavailable

subteam_max_users_exceeded

Exceeds maximum supported number of users per subteam.

team_access_not_granted

The token used is not granted the specific workspace access required to complete this request.

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.

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 user token.

two_factor_setup_required

Two factor setup is required.