CommentsManager

January 23, 2026 ยท View on GitHub

List file comments

Retrieves a list of comments for a file.

This operation is performed by calling function getFileComments.

See the endpoint docs at API Reference.

try await client.comments.getFileComments(fileId: fileId)

Arguments

  • fileId String
    • The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123. Example: "12345"
  • queryParams GetFileCommentsQueryParams
    • Query parameters of getFileComments method
  • headers GetFileCommentsHeaders
    • Headers of getFileComments method

Returns

This function returns a value of type Comments.

Returns a collection of comment objects. If there are no comments on this file an empty collection will be returned.

Get comment

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

This operation is performed by calling function getCommentById.

See the endpoint docs at API Reference.

try await client.comments.getCommentById(commentId: newComment.id!)

Arguments

  • commentId String
    • The ID of the comment. Example: "12345"
  • queryParams GetCommentByIdQueryParams
    • Query parameters of getCommentById method
  • headers GetCommentByIdHeaders
    • Headers of getCommentById method

Returns

This function returns a value of type CommentFull.

Returns a full comment object.

Update comment

Update the message of a comment.

This operation is performed by calling function updateCommentById.

See the endpoint docs at API Reference.

try await client.comments.updateCommentById(commentId: newReplyComment.id!, requestBody: UpdateCommentByIdRequestBody(message: newMessage))

Arguments

  • commentId String
    • The ID of the comment. Example: "12345"
  • requestBody UpdateCommentByIdRequestBody
    • Request body of updateCommentById method
  • queryParams UpdateCommentByIdQueryParams
    • Query parameters of updateCommentById method
  • headers UpdateCommentByIdHeaders
    • Headers of updateCommentById method

Returns

This function returns a value of type CommentFull.

Returns the updated comment object.

Remove comment

Permanently deletes a comment.

This operation is performed by calling function deleteCommentById.

See the endpoint docs at API Reference.

try await client.comments.deleteCommentById(commentId: newComment.id!)

Arguments

  • commentId String
    • The ID of the comment. Example: "12345"
  • headers DeleteCommentByIdHeaders
    • Headers of deleteCommentById method

Returns

This function returns a value of type ``.

Returns an empty response when the comment has been deleted.

Create comment

Adds a comment by the user to a specific file, or as a reply to an other comment.

This operation is performed by calling function createComment.

See the endpoint docs at API Reference.

try await client.comments.createComment(requestBody: CreateCommentRequestBody(message: message, item: CreateCommentRequestBodyItemField(id: fileId, type: CreateCommentRequestBodyItemTypeField.file)))

Arguments

  • requestBody CreateCommentRequestBody
    • Request body of createComment method
  • queryParams CreateCommentQueryParams
    • Query parameters of createComment method
  • headers CreateCommentHeaders
    • Headers of createComment method

Returns

This function returns a value of type CommentFull.

Returns the newly created comment object.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.