This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
This method is used to request additional permissions from a user on a workspace.
Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.
The trigger_id parameter is required and can be found attached to some Events API events, interactive framework action URL invocations, dialog submissions, and other ways we send your app timely, user-initiated data. See these docs about the Permissions API and triggers to learn more.
Common successful response
Standard success response when used with a user token
Common error response
Standard failure response when trigger_id is invalid
A response other than "ok": true indicates the permission request was not presented to the user, perhaps due to an invalid or expired trigger_id.
You'll receive related app events if the user approves or rejects your permissions request. If the user does nothing, no event will emit.
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.
The provided trigger_id has already been exchanged.
There isn't a valid user to request permissions.
Scopes are invalid.
The provided trigger_id is invalid.
No authentication token provided.
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.
Authentication token is for a deleted user or workspace.
Authentication token is for a deleted user or workspace or the app has been removed.
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.
The workspace is undergoing an enterprise migration and will not be available until migration is complete.
Administrators have suspended the ability to post a message.
The token used is not granted the specific scope permissions required to complete this request.
The token type used in this request is not allowed.
The method has been deprecated.
The endpoint has been deprecated.
Two factor setup is required.
The method cannot be called from an Enterprise.
This method cannot be called by a bot user.
The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.
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.
The method was passed an array as an argument. Please only input valid strings.
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.
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.
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.
The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
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.
The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
Access to this method is limited on the current network
The method was called via a POST request, but the POST data was either missing or truncated.
The service is temporarily unavailable
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.
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.
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.
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.
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.