files.sharedPublicURL
Enables a file for public/external sharing.
Facts
Method URL: | https://slack.com/api/files.sharedPublicURL | ||||
---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||
Rate limiting: | Tier 3 | ||||
Works with: |
|
A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
This method enables public/external sharing for a file.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
file
File to share
ExampleF1234567890
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
Response
The response contains a file object, including the permalink_public
url.
{
"ok": true,
"file": {
"id" : "F2147483862",
"timestamp" : 1356032811,
"name" : "file.htm",
"title" : "My HTML file",
"mimetype" : "text\/plain",
"filetype" : "text",
"pretty_type": "Text",
"user" : "U2147483697",
"mode" : "hosted",
"editable" : true,
"is_external": false,
"external_type": "",
"size" : 12345,
"url_private": "https:\/\/slack.com\/files-pri\/T024BE7LD-F024BERPE\/1.png",
"url_private_download": "https:\/\/slack.com\/files-pri\/T024BE7LD-F024BERPE\/download\/1.png",
"thumb_64": "https:\/\/slack-files.com\/files-tmb\/T024BE7LD-F024BERPE-c66246\/1_64.png",
"thumb_80": "https:\/\/slack-files.com\/files-tmb\/T024BE7LD-F024BERPE-c66246\/1_80.png",
"thumb_360": "https:\/\/slack-files.com\/files-tmb\/T024BE7LD-F024BERPE-c66246\/1_360.png",
"thumb_360_gif": "https:\/\/slack-files.com\/files-tmb\/T024BE7LD-F024BERPE-c66246\/1_360.gif",
"thumb_360_w": 100,
"thumb_360_h": 100,
"permalink": "https:\/\/coolkids.slack.com\/files\/cal\/F024BERPE\/1.png",
"permalink_public": "https:\/\/slack-files.com\/T024BE7LD-F024BERPE-8004f909b1",
"edit_link": "https:\/\/coolkids.slack.com\/files\/cal\/F024BERPE\/1.png/edit",
"preview": "<!DOCTYPE html>\n<html>\n<meta charset='utf-8'>",
"preview_highlight": "<div class=\"sssh-code\"><div class=\"sssh-line\"><pre><!DOCTYPE html...",
"lines" : 123,
"lines_more": 118,
"is_public": true,
"public_url_shared": false,
"channels": ["C024BE7LT", ...],
"groups": ["G12345", ...],
"initial_comment": {...},
"num_stars": 7,
"is_starred": true
},
"comments": [
{
"id": "Fc027BN9L9",
"timestamp": 1356032811,
"user": "U2147483697",
"comment": "This is a comment"
},
...
],
"paging": {
"count": 100,
"total": 2,
"page": 1,
"pages": 0
}
}
The file object contains information about the uploaded file.
Each comment object in the comments array contains details about a single comment. Comments are returned oldest first.
The paging information contains the count
of comments returned, the total
number of
comments, the page
of results returned in this response and the total number of pages
available. Please note that the max count
value is 1000
and the max page
value is 100
.
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 |
---|---|
file_not_found | Value passed for |
not_allowed | Public sharing has been disabled for this team |
public_video_not_allowed | Public sharing of videos is not available. A |
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 when using a |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
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. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
deprecated_endpoint | The endpoint has been deprecated. |
two_factor_setup_required | Two factor setup is required. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
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. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
invalid_arguments | 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. |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
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. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
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 |
superfluous_charset | The method was called via a |