Skip to content
Longport WhaleLongport Whale
Fund Company

Update Fund Company

Edit the information of an existing fund company.

Request parameters

  • Required: id (company ID), data (fields to update), data.company_name_locals (localized company name).
  • Optional: data.company_name (company name), data.company_profile_locals (localized profile), data.company_profile (company profile), data.icon (icon), audit_frontend_resource (audit context).
  • Send data as a nested object, not as flattened data.xxx keys.
  • id is the id of the company row in the fund company list. The frontend takes it from the list row; the fund_companies list response does not currently document this field.
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

The company is located by id; data carries the name, profile, icon, and other fields to update.

Returns

On success the fund company is updated; see the 200 response for the exact payload.

POSThttps://b-api.lbkrs.com/funds/admin/update-company

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.fund_company

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

Request body application/json

idstringrequired

Company ID, the id of the company row in the fund company list.

dataobjectrequired

Fund company fields to update.

Child attributes
company_namestring

Company name. The admin frontend form does not send this field.

company_name_localsstringrequired

Localized company name, as a JSON-encoded object keyed by zh-CN, en, and zh-HK.

company_profilestring

Company profile. The admin frontend form does not send this field.

company_profile_localsstring

Localized company profile, as a JSON-encoded object keyed by zh-CN, en, and zh-HK.

iconstring

Icon.

audit_frontend_resourceobject

Audit Context. Provides audit context for this operation.

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