Skip to content
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.longbridge.xyz/atm/modify/lookup

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Lookup ID associated with this request.

categorystringrequired

This field is disabled and cannot be modified when editing; values come from the atm_remark_category dynamic enum, with known values: setting_remark_deposit - Deposit, setting_remark_securitiesdeposit

  • Securities Deposit, setting_remark_securitieswithdrawal - Securities Withdrawal, setting_remark_withdrawal - Withdrawal, setting_remark_accountadjustment - Account Adjustment, setting_remark_withdrawal_reject - Withdrawal Rejection, setting_remark_deposit_reject - Deposit Rejection, setting_remark_deposit_matching - Deposit Matching.

Allowed 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

Call GET /v1/datasets/refs/atm_remark_category to retrieve the current data dictionary, and use the returned entry's key as this field's value.

setting_remark_deposit · Depositsetting_remark_withdrawal · Withdrawalsetting_remark_securitiesdeposit · Securities Depositsetting_remark_securitieswithdrawal · Securities Withdrawalsetting_remark_accountadjustment · Account Adjustmentsetting_remark_withdrawal_reject · Withdrawal rejectionsetting_remark_deposit_reject · Deposit rejectionsetting_remark_withdrawal_card_reject · Refuse Add Bank Cardsetting_remark_fund · Fundsetting_remark_otc_derivatives · OTC Derivativessetting_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

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