Skip to content
Longport WhaleLongport Whale
Flow Tickets

Create Comment

Adds a comment to a business object such as a ticket or an approval step.

Request parameters

  • Required: target_type (associated object type), target_id (associated object ID), and text (comment content).
  • See each field's own documentation for format, accepted values, and business meaning.

Business notes

This is a shared endpoint of the common ticket-approval system. The comment is linked to a specific business object through target_type and target_id.

Result

On success, the comment is created; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/admin-api/comments

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

target_typestringrequired

Specifies Target Type. The set of accepted values could not be confirmed from the frontend; refer to the backend definition.

target_idnumberrequired

Target ID associated with this request.

textstringrequired

Specifies Text. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring
HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs