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

/bff/issue/add-email

Adds a customer-visible reply (channel = email_out) and sends it as an e-mail to the reporter and assignee via sendIssueCommentToEmail. Use /add-comment for staff-only notes. Optionally accepts targetStatusId to apply a status change atomically before the e-mail is rendered (used by the "Send and close" composer button so the outbound e-mail carries the post-close status badge).

IssuepostBffIssueAdd-email

Parameters

JSON body

Request body

application/json
issueKeystringRequired

Issue key to reply on.

ExamplePROJ-123
messagestringRequired

E-mail body text.

Length: 1–∞
ExampleDobrý den, faktura byla opravena a přeposlána na Vaši adresu.
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 outbound e-mail is dispatched. Used by the "Send and close" composer to bundle a status change with the reply in a single BFF call so the customer's e-mail carries the final status badge (e.g. Stav: Dokončeno when closing the ticket). Must be a system status or belong to the caller organisation.

Example4

Response schema

1 status code documented

200Success
successbooleanRequired

Whether the reply was sent successfully.

commentIdstringRequired

Generated comment ID.

ExamplePROJ-123_c456
recipientsstring[]Required

E-mail addresses the reply was queued for (BIZKIT-75).

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",
  "recipients": [
    "string"
  ],
  "orderNumber": "26000123",
  "orderHash": "example_orderHash"
}

Request example

POST /bff/issue/add-email

post
curl -X POST "https://api.bizkithub.com/bff/issue/add-email" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "issueKey": "PROJ-123",
  "message": "Dobrý den, faktura byla opravena a přeposlána na Vaši adresu.",
  "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