Skip to content

Latest commit

 

History

History
103 lines (82 loc) · 6.13 KB

usergroups.disable.md

File metadata and controls

103 lines (82 loc) · 6.13 KB
Raw

Disable an existing User Group

Facts

| Method URL: | https://slack.com/api/usergroups.disable | | Preferred HTTP method: | POST | | Accepted content types: | application/x-www-form-urlencoded, application/json | | Rate limiting: | Tier 2 | | Works with: |

Token type Required scope(s)
bot usergroups:write 
user usergroups:write 

|

This method disables an existing User Group.

Arguments

Argument Example Required Description
token xxxx-xxxxxxxxx-xxxx Required Authentication token bearing required scopes.
usergroup S0604QSJC Required The encoded ID of the User Group to disable.
include_count true Optional Include the number of users in the User Group.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Response

{
    "ok": true,
    "usergroup": {
        "id": "S0615G0KT",
        "team_id": "T060RNRCH",
        "is_usergroup": true,
        "name": "Marketing Team",
        "description": "Marketing gurus, PR experts and product advocates.",
        "handle": "marketing-team",
        "is_external": false,
        "date_create": 1446746793,
        "date_update": 1446747568,
        "date_delete": 1446747568,
        "auto_type": null,
        "created_by": "U060RNRCZ",
        "updated_by": "U060RNRCZ",
        "deleted_by": "U060RNRCZ",
        "prefs": {
            "channels": [

            ],
            "groups": [

            ]
        },
        "user_count": "0"
    }
}

When a User Group has been disabled its date_delete parameter will be non-zero.

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.

Error Description
permission_denied The user does not have permission to disables 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.
not_authed No authentication token provided.
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.
account_inactive Authentication token is for a deleted user or workspace.
token_revoked Authentication token is for a deleted user or workspace or the app has been removed.
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.
ekm_access_denied Administrators have suspended the ability to post a message.
missing_scope The token used is not granted the specific scope permissions required to complete this request.
is_bot This method cannot be called by a bot user.
user_is_restricted This method cannot be called by a restricted user or single channel guest.
invalid_arguments The method was called with invalid arguments.
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_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.
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.
request_timeout The method was called via a POST request, but the POST data was either missing or truncated.
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.

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.

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