Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
Exampletrue
Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.
Response
The response indicates whether the token was actually revoked, using a boolean revoked field.
Typical success response
{
"ok": true,
"revoked": true
}
Typical error response
{
"ok": false,
"error": "invalid_auth"
}
For a workspace app, you may revoke either a long-lived refresh token or a short-lived access token. In both cases, the token is revoked without further side effects: the app is not uninstalled. To uninstall a workspace app, use the app.uninstall method.
Revoking all user tokens an app has for a workspace will result in the app becoming uninstalled.
Revoking a bot user token will not uninstall the bot user or the app. It essentially resets the token value and you can obtain it again through another run through of the OAuth process. Internal integrations and apps installed only on your team offer the new bot user token in your app management console.
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
not_bearer_token
Incompatible token type provided
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.
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-8iso-8859-1.
invalid_form_data
The method was called via a POST request with Content-Typeapplication/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/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/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.
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.
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.
