Skip to main content

​
MCP tool: update_comment

Updates an existing comment with new content, visibility settings, or other properties. Useful for correcting typos, updating information, or changing comment visibility.

​
Example prompt

Update comment 60YJS01K10TQY9F7W3V19QZ857TFY with content "Updated: This comment has been modified to include more detailed information about the ticket status. The investigation is ongoing and we expect to have a resolution by end of day today. Thanks for your patience while we work through this performance issue."

​
Input parameters

NameTypeRequiredDescription
commentIdstringYesThe ID of the comment to update
contentstringYesThe updated content of the comment (1-5000 chars)
contentHtmlstringNoThe updated HTML content of the comment (max 5000 chars)
contentJsonstringNoThe updated JSON content of the comment
threadNamestringNoThe updated name of the comment thread
commentVisibilityenumNoThe visibility of the comment (“public” or “private”)
commentTypeenumNoThe type of the comment (“comment” or “note”)
isPinnedbooleanNoWhether the comment is pinned
preserveMentionsbooleanNoWhether to preserve mentions when updating content
attachmentsstring[]NoThe attachments of the comment
commentAsstringNoThe comment as a string
metadataobjectNoThe updated metadata of the comment
updatedAtstringNoThe update timestamp

​
Response fields

Below are the fields you may see in the response:
FieldTypeDescription
idstringComment unique ID
contentstringUpdated plain text content of the comment
contentHtmlstringUpdated HTML formatted content
contentMarkdownstringUpdated Markdown formatted content
contentJsonstringUpdated JSON formatted content
isEditedbooleanWhether the comment has been edited
threadNamestringName of the comment thread
commentVisibilitystringUpdated visibility setting
commentTypestringUpdated type of comment
isPinnedbooleanWhether the comment is pinned
sourceEmailIdstringEmail ID if comment came from email
metadataobjectUpdated metadata (may include mentions, lastEditedAt, lastEditedBy, etc.)
createdAtstring (ISO8601)Original creation timestamp
updatedAtstring (ISO8601)Last update timestamp
authorstringAuthor display name
authorAvatarUrlstringAuthor’s avatar URL
attachmentsarrayUpdated attachment IDs
authorIdstringAuthor’s user ID
authorUserTypestringAuthor’s user type (e.g., ORG_ADMIN)
impersonatedUserEmailstringEmail of impersonated user
impersonatedUserNamestringName of impersonated user
impersonatedUserAvatarstringAvatar of impersonated user
deletedAtstringDeletion timestamp (null if not deleted)

​
Sample response

{
  "data": {
    "id": "60YJS01K10TQY9F7W3V19QZ857TFY",
    "content": "Updated: This comment has been modified to include more detailed information about the ticket status. The investigation is ongoing and we expect to have a resolution by end of day today. Thanks for your patience while we work through this performance issue.",
    "contentHtml": "Updated: This comment has been modified to include more detailed information about the ticket status. The investigation is ongoing and we expect to have a resolution by end of day today. Thanks for your patience while we work through this performance issue.",
    "contentMarkdown": "Updated: This comment has been modified to include more detailed information about the ticket status. The investigation is ongoing and we expect to have a resolution by end of day today. Thanks for your patience while we work through this performance issue.",
    "contentJson": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":\"left\"},\"content\":[{\"type\":\"text\",\"text\":\"Updated: This comment has been modified to include more detailed information about the ticket status. The investigation is ongoing and we expect to have a resolution by end of day today. Thanks for your patience while we work through this performance issue.\"}]}]}",
    "isEdited": true,
    "threadName": null,
    "commentVisibility": "public",
    "commentType": "comment",
    "isPinned": false,
    "sourceEmailId": null,
    "metadata": {
      "mentions": [],
      "lastEditedAt": "2025-07-25T12:54:43.379Z",
      "lastEditedBy": "8"
    },
    "createdAt": "2025-07-25T12:40:33.539Z",
    "updatedAt": "2025-07-25T12:54:42.597Z",
    "author": "shakthi+1",
    "authorAvatarUrl": null,
    "attachments": [],
    "authorId": "UTH00SEXXFNVVN",
    "authorUserType": "ORG_ADMIN",
    "impersonatedUserEmail": null,
    "impersonatedUserName": null,
    "impersonatedUserAvatar": null,
    "deletedAt": null
  },
  "status": true,
  "message": "Comment updated successfully!",
  "timestamp": "2025-07-25T12:54:43.666Z"
}