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 was for editing an existing comment on a file. Only the user who created a comment could make edits. Teams could configure a limited time window during which file comment edits were allowed. File comments have been replaced by file threads and this method will retire on May 22nd, 2019.
Authentication token bearing required scopes.
Everyone should take a moment to read this file, seriously.
Text of the comment to edit.
File containing the comment to edit.
The comment to edit.
This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.
If successful, the response will include a file comment object.
"comment": "Everyone should take a moment to read this file, seriously."
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 requested file could not be found.
The requested file was previously deleted.
The comment field was empty.
The timeframe for editing the comment has expired.
The requested file could not be found.
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 method was called with invalid arguments.
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 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 method was called via a POST request, but the POST data was either missing or truncated.
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.
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.