Skip to content
Longport WhaleLongport Whale
Remarks template

Modify Lookup

Updates Lookup.

Request parameters

  • Required: id (Lookup ID), category (Remark Category), value_cn (Remark Content (Simplified Chinese)), value_hk (Remark Content (Traditional Chinese)), value_en (Remark Content (English)), priority (Priority)
  • Optional: audit_frontend_resource (Audit Context)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

PUThttps://b-api.lbkrs.com/atm/modify/lookup

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.modify_lookup

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

idstringrequired

Lookup ID associated with this request.

categorystringrequired

Remark category. This field is read-only and cannot be modified when editing.

Values
setting_remark_deposit
Deposit
setting_remark_withdrawal
Withdrawal
setting_remark_securitiesdeposit
Securities Deposit
setting_remark_securitieswithdrawal
Securities Withdrawal
setting_remark_accountadjustment
Account Adjustment
setting_remark_withdrawal_reject
Withdrawal rejection
setting_remark_deposit_reject
Deposit rejection
setting_remark_withdrawal_card_reject
Refuse Add Bank Card
setting_remark_fund
Fund
setting_remark_otc_derivatives
OTC Derivatives
setting_remark_deposit_matching
Deposit Matching
value_cnstringrequired

Up to 128 characters; up to 500 characters when category is setting_remark_withdrawal_reject or setting_remark_deposit_reject.

value_hkstringrequired

The length limit is the same as value_cn.

value_enstringrequired

The length limit is the same as value_cn.

prioritynumberrequired

Value range 1-999999.

audit_frontend_resourceobject

Snapshot of the record before modification, used for audit tracing; not a user-entered field.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean
idstring
tipstring
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