Update the list of users for a user group.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/usergroups.users.update
Bolt for Java
app.client().usergroupsUsersUpdate
Powered by Bolt
Bolt for Python
app.client.usergroups_users_update
Powered by Bolt
Bolt for JavaScript
app.client.usergroups.users.update
Powered by Bolt

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 2
  • Arguments

    Required arguments

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

    Example
    xxxx-xxxxxxxxx-xxxx

    The encoded ID of the user group to update.

    Example
    S0604QSJC

    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 the number of users in the user group.

    Example
    true

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

    Example
    T1234567890

    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. To call this method successfully, the calling user must have permission (verify in workspace settings).

    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.

    Example responses

    Common successful 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
        }
    }

    Common error response

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

    ErrorDescription
    invalid_users

    Value passed for users was empty or invalid.

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

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

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

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

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

    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.

    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

    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.

    Warnings

    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.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response