ROrocketlane
Comments

Create a comment

Changed on

The Create Comment API allows users to add a comment to a specific conversation within a project. This endpoint enables seamless collaboration by allowing team members to contribute to discussions, provide updates, or share feedback. Upon a successful request, the API returns the newly created comment along with metadata such as timestamps, author details, and status.

post/1.0/comments

Request

Query parameters

includeFieldsstring

Request body

contentstring required

Content of the comment

isPrivateboolean

Example request

{
  "content": "This is a comment",
  "source": {
    "sourceId": 201,
    "sourceType": "PROJECT_CONVERSATIONS"
  },
  "attachments": [
    {
      "attachmentId": 201
    }
  ]
}

Response

The resource was successfully created in the database.

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