Skip to content
Permalink
Branch: master
Find file Copy path
27 lines (20 sloc) 952 Bytes

users.admin.setInactive

This method disables a user. A disabled user can no longer log into a Slack team. Note: This method does not work on free tier. Note that you need a legacy token for this method.

Arguments

This method has the URL https://slack.com/api/users.admin.setInactive and follows the Slack Web API calling conventions.

Argument Example Required Description
token xxxx-xxxxxxxxx-xxxx Required Authentication token (Requires scope: client)
user U1234567890 Required ID of the user to be disabled

Response

You will receive a standard Slack API response in JSON as described here. For example if successful you get:

{
"ok": true
}

Errors & Warnings

Error Description
paid_only Error message when used with a free Slack team
You can’t perform that action at this time.