Skip to content
Flow Tickets

Handle Ticket

Performs approval-related operations on a ticket. This is the currently active core entry point of the common ticket-approval system (it supersedes the deprecated PUT /admin-api/flow_ticket_steps/{stepId}). The action field selects the operation, supporting approve, reject, comment, transfer, CC, add-signer, close, and rollback.

Request parameters

  • Required: id (ticket ID) and action (the operation).
  • Optional: comment, user_ids, role_ids, payload (business data), and data (extension data).
  • Different actions need different optional fields — for example transfer/CC/add-signer require user_ids or role_ids. 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. Actions such as approve, reject, and rollback advance the ticket's workflow and may trigger downstream real business actions.

Risk warning

This changes the ticket's approval state or workflow direction, and some actions may trigger real fund, position, or configuration changes. Confirm the target ticket, the action, and the related parameters before calling.

Result

On success, the corresponding approval action is completed; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/admin-api/v2/tickets/{id}

Authorization

AuthorizationstringheaderRequired

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

Parameters

idstringRequired

Path parameter.

Request body application/json

actionstringrequired

Type of operation to perform for this request. This field is required.

Allowed values: approve Approve, reject Reject, close Close, comment Comment, transfer Assign to, cc Copy, sign Add approver, rollback Roll back

Values
approve
Approve
reject
Reject
close
Close
comment
Comment
transfer
Assign To
cc
CC
sign
Add Approver
rollback
Rollback
commentstring

Optional depending on action.

user_idsarray<string>

Optionally filled based on action, e.g. forward / CC / countersign.

role_idsarray<string>

Optional depending on action.

payloadobject

Specifies Payload.

dataobject

Specifies Data.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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