Comments

Change a comment's status

Sets the status of one comment. Status is the only field the API can change: comment text cannot be edited (sending text returns 400) and comments cannot be deleted. Setting resolved marks the comment resolved; any other status marks it unresolved. A real change triggers a comment.status_changed event with source set to connector:<key_id>. Requires the write scope.

patch/comments/{id}

Request

  • Base URL: https://app.huddlekit.com/api/v1
  • URL: https://app.huddlekit.com/api/v1/comments/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Id of the comment to update (a UUID).

Request body

status'open' | 'in-review' | 'in-progress' | 'resolved' required

Workflow status of a comment. Setting resolved also marks the comment resolved; any other value marks it unresolved.

surface'website' | 'webapp' | 'document'

What a comment is attached to. website: a website project (the parent is a project). webapp: a web app that runs the Huddlekit SDK widget (the parent is a web app). document: an uploaded PDF, image or video (the parent is a document).

Example request

{
  "status": "resolved",
  "surface": "website"
}

Response

The status was updated.

surface'website' | 'webapp' | 'document' required

What a comment is attached to. website: a website project (the parent is a project). webapp: a web app that runs the Huddlekit SDK widget (the parent is a web app). document: an uploaded PDF, image or video (the parent is a document).

Example response

{
  "comment": {
    "id": "6b1f9c2e-4d7a-4c1b-9e3f-2a8d5c7b1e04",
    "comment_number": 42,
    "text": "The signup button overlaps the footer on mobile.",
    "status": "resolved",
    "updated_at": "2026-09-27T08:05:00.000Z"
  },
  "surface": "website"
}

Changes

No recorded changes to this operation across all 1 revision of this API.