ROrocketlane
Comments

Update comment

Changed on

The Update Comment API allows users to modify an existing comment within a conversation using its unique commentId. This endpoint enables updates to the comment content, status, or metadata while preserving its original context within the conversation. This API is particularly useful for making corrections, appending additional information, or updating comment visibility.

put/1.0/comments/{commentId}

Request

Path parameters

commentIdinteger required

The ID of the comment object

Query parameters

includeFieldsstring
includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Request body

commentIdinteger

Comment ID

contentstring

Updated comment content

isPrivateboolean

Example request

{
  "commentId": 201,
  "content": "This is an updated comment"
}

Response

The requested action was successfully executed.

commentIdinteger

Unique identifier for the comment

contentstring

Content of the comment

createdAtinteger

Timestamp representing the creation time of the comment

privateboolean

Indicates whether the comment is private or public

Example response

{
  "commentId": 201,
  "content": "This is a sample comment",
  "createdAt": 1681319726000,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "source": {
    "sourceId": 201,
    "sourceType": "PROJECT_CONVERSATIONS"
  },
  "attachments": [
    {
      "attachmentId": 201,
      "attachmentName": "test_upload.png",
      "createdAt": 1680616174929,
      "location": "https://rocketlane.com/attachments/0/db83eb19-0bbf-4a37-b4e2-cd1b96708c73/test_upload.png",
      "thumbLocation": "https://rocketlane.com/attachments/0/db83eb19-0bbf-4a37-b4e2-cd1b96708c73/thumb_test_upload.png"
    }
  ],
  "private": true
}

Changes