Sample - Slack Web API
POST/files.remote.update

Update a remote file

Updates an existing remote file registered with the service. Identify the file with file or external_id, then provide the metadata you want to change. You can update its title, type, URL, preview image, and searchable contents.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

8 body fields

Form-encoded data identifying the remote file and the metadata to update.

tokenstringoptional
Authentication token. Requires scope: `remote_files:write`
filestringoptional
Specify a file by providing its ID.
external_idstringoptional
Creator defined GUID for the file.
titlestringoptional
Title of the file being shared.
filetypestringoptional
type of file
external_urlstringoptional
URL of the remote file.
preview_imagestringoptional
Preview of the document via `multipart/form-data`.
indexable_file_contentsstringoptional
File containing contents that can be used to improve searchability for the remote file.

2 status codes
200Returns an object with `ok` set to true when the remote file is updated.
okbooleanrequired
Allowed:true
defaultReturns an object with `ok` set to false when the remote file cannot be updated or the request is invalid.
okbooleanrequired
Allowed:false

Error handling

The authentication token must have the remote_files:write scope. file or external_id must identify the existing remote file, and preview_image must use multipart form data when supplied.