/bff/issue/add-comment

Adds an internal comment (channel = internal) to an issue. The author is derived from the authenticated user. The comment is visible only to staff in the admin timeline; no e-mail is sent to the reporter or the assignee. Use /add-email when the operator wants the message to reach the customer. Optionally accepts targetStatusId to apply a status change atomically with the comment (used by the "Send and close" composer button).

IssuepostBffIssueAdd-comment

Parameters

JSON body

Request body

application/json

issueKeystringRequired

Issue key to comment on.

ExamplePROJ-123

messagestringRequired

Comment message text.

Length: 1–∞

ExampleTalked to Petr, he agreed to a 20% discount.

targetStatusIdnumberOptional

Optional status id to apply BEFORE the comment is inserted. Used by the "Send and close" composer to bundle a status change with the reply in a single BFF call; the activity feed and timeline observe the final status. Must be a system status or belong to the caller organisation.

Example4

Response schema

1 status code documented

200Success

successbooleanRequired

Whether the comment was added successfully.

commentIdstringRequired

Generated comment ID.

ExamplePROJ-123_c456

Response example

application/json

{
  "success": false,
  "commentId": "PROJ-123_c456"
}

Request example

POST /bff/issue/add-comment

post

curl -X POST "https://api.bizkithub.com/bff/issue/add-comment" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "issueKey": "PROJ-123",
  "message": "Talked to Petr, he agreed to a 20% discount.",
  "targetStatusId": 4
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key