Skip to content
Flow Tickets

Handle Ticket

The core endpoint of the general ticket-approval system and the currently active entry point for approval actions (replacing the deprecated approve_flow_ticket_step). comment = comment, transfer = transfer, cc = carbon copy, sign = add approver, close = close; reject/rollback are also supported.

Request parameters

  • Required: action (Action), id (id)
  • Optional: comment (Comment), user_ids (User IDs), role_ids (Role IDs), payload (Payload), data (Data)
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

POSThttps://b-api.longbridge.xyz/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 - CC
  • sign - Add Approver
  • rollback - Rollback

approve · Approvereject · Rejectclose · Closecomment · Commenttransfer · Assign Tocc · CCsign · Add Approverrollback · 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