PATCH /comment/{commentId} — update a comment

Use this endpoint to modify an existing comment. You can update any combination of the comment’s text, status, priority, visibility, or file attachment in a single request. At least one body field must be provided. When uploading an attachment, use multipart/form-data as the content type; otherwise, application/json is acceptable.

PATCH https://api.bugsmash.io/api/v2/comment/{commentId}

Path parameters

string

required

The UUID of the comment to update.

Request body

All fields are optional, but at least one must be included.

string

Updated comment text.

string

New status for the comment. Accepted values: "Active" or "Resolved".

string

Priority level. Accepted values: "Unset", "P1", "P2", "P3", or "P4".

boolean

Set to true to make the comment private, or false to make it visible to all reviewers.

file

An image file (e.g., jpg, png) to attach to the comment. Requires multipart/form-data.

Request example

curl --location --request PATCH 'https://api.bugsmash.io/api/v2/comment/{commentId}' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'text="Updated comment text"' \
--form 'status="Resolved"'

Response example

{
  "status": true,
  "message": "Comment updated",
  "data": {
    "comment_id": "d4e5f6a7-b8c9-0123-defa-123456789013",
    "comment": "<p>Updated comment text.</p>",
    "comment_number": 7,
    "status": "Resolved",
    "created_at": "2026-04-06T14:04:05.000000Z",
    "updated_at": "2026-04-06T15:18:36.000000Z",
    "is_private": true,
    "comment_by_name": "John Doe",
    "comment_by_email": "user@example.com",
    "assigned_to_name": null,
    "assigned_to_email": null,
    "priority": "P1",
    "attachment_file_url": "https://cdn.bugsmash.io/files/{workspace-id}/image/attachment-example.png",
    "project_type": "pdf",
    "comment_screenshot_file_url": null
  }
}

Response fields

boolean

true when the update succeeded.

string

A human-readable description of the result.

object

The updated comment object.

Show properties

string

UUID of the comment.

string

Updated comment text as HTML.

number

Sequential number identifying this comment within the project.

string

Current status. Either "Active" or "Resolved".

string

ISO 8601 timestamp of when the comment was originally created.

string

ISO 8601 timestamp of this update.

boolean

Whether the comment is now private.

string

Display name of the reviewer who posted the comment.

string

Email address of the reviewer who posted the comment.

string

Display name of the assignee. null if unassigned.

string

Email address of the assignee. null if unassigned.

string

Priority level. One of "Unset", "P1", "P2", "P3", or "P4".

string

URL of the newly attached file. null if no attachment.

string

The type of the parent project (e.g., "pdf").

string

URL of the context screenshot. null if not present.

Folders

Versions

Projects

Comments

Webhooks

PATCH /comment/{commentId} — update a comment

Path parameters

Request body

Request example

Response example

Response fields

​Path parameters

​Request body

​Request example

​Response example

​Response fields

Path parameters

Request body

Request example

Response example

Response fields