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

/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.
paymentRequestobjectOptional

Attach a payment request: a technical order is created via createOrder() (customer = reporter, no order notification e-mail) and linked to the comment. The outbound e-mail then carries a pay button (when an online gateway serves the group), a bank-transfer QR code (CZK/EUR account in the request currency), or an info-only block. Requires module-order.

orderGroupCodestringRequired

Code of an ACTIVE order group of the organisation (see /payment-request-options).

Length: 1–∞
Exampledefault
currencystringRequired

ISO 4217 code of a currency enabled for the organisation (see /payment-request-options).

Length: 3–3
ExampleCZK
itemsobject[]Required

Virtual line items of the technical order (1 to 20).

Each array item:
labelstringRequired

Line item label shown to the customer.

Length: 1–255
ExampleKonzultace
pricenumberRequired

Line amount incl. VAT in the request currency. Must be > 0.

Example1500
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
orderNumberstringOptional

Number of the payment request order, when paymentRequest was sent.

Example26000123
orderHashstringOptional

Hash of the payment request order (admin link /order/<hash>).

Response example

application/json
{
  "success": false,
  "commentId": "PROJ-123_c456",
  "orderNumber": "26000123",
  "orderHash": "example_orderHash"
}

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.",
  "paymentRequest": {
    "orderGroupCode": "default",
    "currency": "CZK",
    "items": [
      {
        "label": "Konzultace",
        "price": 1500
      }
    ]
  },
  "targetStatusId": 4
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key