Skip to content
Fund File

Add Fund File

Creates a fund file (such as product material or an announcement), configuring its localized display names, download links, usage scenarios, file type, and applicable user groups.

Request parameters

  • Required: name_locales (localized display names), link_locales (localized file links), scenarioes (usage scenarios), file_type (file type)
  • Optional: file_name_locales (localized original file names), remark (note), user_group_ids (applicable user groups), audit_frontend_resource (caller-provided audit context snapshot)
  • See the field descriptions for the format, value range, and business meaning of each field.

Business notes

scenarioes determines the scenarios in which the file is shown, and user_group_ids can restrict which user groups can see it.

Risk warning

This operation adds a customer-facing fund file. Confirm the links, display names, and applicable scope before calling.

Result

On success, the file is created. The resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/funds/admin/add-fund-file

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.fund_file_update

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

Request body application/json

name_localesstringrequired

Display Name (Locales). A JSON string whose key is the language (zh-CN/zh-HK/en) and whose value is the display name for that language.

link_localesstringrequired

File Link (Locales). A JSON string that collects the identifiers and names of the files uploaded for each locale, submitted after encoding.

file_name_localesstring

Original File Name (Locales). A JSON string mapping each language to the original uploaded file name.

remarkstring

Remark.

scenarioesstringrequired

Usage Scenario. Multi-select; submitted as an array of selected enum values.

Values
popup_fund_details_subscription
popup_aip_submit
inline_fund_order_subscription
inline_fund_order_redemption
inline_fund_details_profile
inline_private_fund_details_fundamental_information
user_group_idsstring

User Group IDs.

file_typenumberrequired

File Type. The client passes a fixed value of 7, representing the "Fund File" type; not an editable field.

audit_frontend_resourceobject

Audit Context. An audit-trail object assembled by the client, containing snapshots of the operation type, name, remarks, per-language files, scenario, user group, and so on, used for back-office auditing. It is not a business field entered directly by the user.

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