BizKitHub
DocsAPI ReferenceIssue/bff/issue/update-comment
postIssueAdmin BFF

/bff/issue/update-comment

Updates the body of an existing comment and stores a diff in the activity log via formatActivityFieldDiff. Edits are restricted to the original human author (AI/system/inbound-mail entries are immutable). When the comment was previously sent as an e-mail (channel = email_out), the caller can opt in to a re-dispatch via resend: true; the admin UI surfaces a confirm dialog for this choice. Internal comments always skip the dispatch regardless of resend.

IssuepostBffIssueUpdate-comment

Parameters

JSON body

Request body

application/json
issueKeystringRequired

Issue key that owns the comment.

ExamplePROJ-123
commentIdstringRequired

Full wire-format comment id from IssueCommentItem.id — ${issueKey}_c${dbId}.

ExamplePROJ-123_c456
messagestringRequired

New comment body.

Length: 1–∞
ExampleUpdated — I spoke with the customer again.
resendbooleanOptional

Only honoured when the edited comment is channel email_out. True → re-dispatch the e-mail to the reporter + assignee with the new body; false (default) → persist the edit silently.

Examplefalse

Response schema

1 status code documented

200Success
successbooleanRequired

Whether the edit was applied.

commentIdstringRequired

Comment ID (unchanged from input).

ExamplePROJ-123_c456
changedbooleanRequired

True when the message content actually changed (false on a save with no modifications).

resentbooleanRequired

True when the edit triggered a customer e-mail re-dispatch.

Response example

application/json
{
  "success": false,
  "commentId": "PROJ-123_c456",
  "changed": false,
  "resent": false
}

Request example

POST /bff/issue/update-comment

post
curl -X POST "https://api.bizkithub.com/bff/issue/update-comment" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "issueKey": "PROJ-123",
  "commentId": "PROJ-123_c456",
  "message": "Updated — I spoke with the customer again.",
  "resend": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key