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 updates a remote file.
Arguments
Argument
Example
Required
Description
token
xxxx-xxxxxxxxx-xxxx
Required
Authentication token bearing required scopes.
external_id
123456
Optional
Creator defined GUID for the file.
external_url
http://example.com/my_cloud_service_file/abc123
Optional
URL of the remote file.
file
F2147483862
Optional
Specify a file by providing its ID.
filetype
doc
Optional
type of file
indexable_file_contents
...
Optional
File containing contents that can be used to improve searchability for the remote file.
preview_image
...
Optional
Preview of the document via multipart/form-data.
title
Danger, High Voltage!
Optional
Title of the file being shared.
Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.
You cannot update the external_id or file_id of a remote file. If you need to change those fields, your best bet is to remove and then add the file.
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
bad_image
The uploaded image could not be processed - try passing a JPG or PNG
too_large
The uploaded image had excessive dimensions
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.
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.