Skip to content
Longport WhaleLongport Whale
Account Attributes

Modify Account Attribute

Modify an existing Account Attribute configuration.

Request parameters

  • Required: id (the account attribute id of the record to update).
  • Required: record (the updated fields), where name (attribute name), direct (balance side), and prefix_code (level-1 account code serial number) are all required.
  • See each field for its format, allowed values, and business meaning.

Result

On success, the target Account Attribute record is updated. See the 200 response schema for returned data.

POSThttps://b-api.longbridge.xyz/book/feature/modify

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Account attribute id of the record to update.

recordobjectrequired

Updated Account Attribute fields.

Child attributes
namestringrequired

Account attribute name.

directstringrequired

Balance side.

1 · Debit2 · Credit3 · Common

prefix_codestringrequired

Level-1 account code serial number.

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