---
title: "Update comment"
method: PUT
path: "/1.0/comments/{commentId}"
tags: ["Comments"]
---

# Update comment

`PUT /1.0/comments/{commentId}`

## Request

- Base URL: `https://api.rocketlane.com/api`
- URL: `https://api.rocketlane.com/api/1.0/comments/{commentId}`
- Auth: API key in header `api-key`
- TypeScript: <https://skmtc.dev/rocketlane/apis/rocketlane-api/docs/1.0/comments/:commentId/put.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `commentId` integer, required

## Query parameters

- `includeFields` string
- `includeAllFields` boolean

## Request body

- CommentPublicUpdateRequestAPIEntity
  - `commentId` integer: Comment ID
  - `content` string: Updated comment content
  - `isPrivate` boolean

## Response `200`

The requested action was successfully executed.

- CommentPublicResponseAPIEntity: Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
  - `commentId` integer: Unique identifier for the comment
  - `content` string: Content of the comment
  - `createdAt` integer: Timestamp representing the creation time of the comment
  - `createdBy` CommentCreatedByResponsePublicAPIEntity: Details of the user who created the comment
    - `emailId` string: The user's email identifier.
    - `userId` integer: The unique identifier for the user.
    - `firstName` string: The first name of the user.
    - `lastName` string: The last name of the user.
  - `source` CommentSourcePublicAPIResponseEntity, required: Source associated with the comment
    - `sourceId` integer: Source Id attached to the comment
    - `sourceType` 'TASK' | 'PROJECT_CONVERSATIONS': Source Type attached to the comment
  - `attachments` CommentAttachmentPublicAPIResponseEntity[]: List of attachments associated with the comment
    - `attachmentId` integer: Attachment ID
    - `attachmentName` string: Attachment Name
    - `createdAt` integer: Attachment Created timestamp
    - `location` string: Attachment Location
    - `thumbLocation` string: Attachment Thumb location
    - `visibility` boolean: Attachment Visibility
  - `private` boolean: Indicates whether the comment is private or public

## Other responses

- `400`: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
- `401`: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
- `404`: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.

## Changes

- **2026-11-03** `a002a499e6fc`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/rocketlane/apis/rocketlane-api/changes/1.0/comments/:commentId/put.md)

---

[API](https://skmtc.dev/rocketlane/apis/rocketlane-api.md) - [All operations](https://skmtc.dev/rocketlane/apis/rocketlane-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rocketlane/apis/rocketlane-api/revisions/a002a499e6fc?raw)
