files.comments.edit.md

Edit an existing file comment.

Facts

| Method URL: | https://slack.com/api/files.comments.edit | | Preferred HTTP method: | POST | | Accepted content types: | application/x-www-form-urlencoded, application/json | | Rate limiting: | Tier 2 | | Works with: |

Token type	Required scope(s)
bot	bot
workspace	files:write:user
user	files:write:user

|

---

File threads are here

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.

Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.

Arguments

Argument	Example	Required	Description
token	xxxx-xxxxxxxxx-xxxx	Required	Authentication token bearing required scopes.
comment	Everyone should take a moment to read this file, seriously.	Required	Text of the comment to edit.
file	F1234567890	Required	File containing the comment to edit.
id	Fc1234567890	Required	The comment to edit.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Response

If successful, the response will include a file comment object.

{
    "ok": true,
    "comment": {
        "id": "Fc1234567890",
        "created": 1356032811,
        "timestamp": 1356032811,
        "user": "U1234567890",
        "comment": "Everyone should take a moment to read this file, seriously."
    }
}

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	The requested file could not be found.
file_deleted	The requested file was previously deleted.
no_comment	The comment field was empty.
edit_window_closed	The timeframe for editing the comment has expired.
cant_edit	The requested file could not be found.
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-8 iso-8859-1.
invalid_form_data	The method was called via a POST request with Content-Type application/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/json application/x-www-form-urlencoded multipart/form-data text/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.