Skip to content
Longport WhaleLongport Whale
Statement Template

Update Statement Text Config

Edit the statement copy (text) configuration of a given organization.

Request parameters

  • Required: org_id (organization ID), action_in (action type), en (English copy), zh (Simplified Chinese copy), hk (Traditional Chinese copy)
  • Optional: key (uploaded image key), front_payload (change-diff payload), audit_frontend_resource (caller-provided audit context)
  • See each field description for format, value range, and business meaning.

Business notes

Updates the statement copy for the organization identified by org_id according to the action type in action_in; Simplified Chinese, Traditional Chinese, and English copy must all be provided.

Result

On success the statement copy configuration is updated; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/portfolio/statement/update_statement_text

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.statement_setting

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

Request body application/json

org_idnumberrequired

Organization ID associated with this request.

action_innumberrequired

Specifies the configuration change type.

  • 1: Create a configuration
  • 3: Update an existing configuration

Send the value that corresponds to whether the configuration already exists.

keystring

The storage key returned after the image is uploaded.

enobjectrequired

English text content (assembled from the input values).

zhobjectrequired

This field is required.

hkobjectrequired

This field is required.

front_payloadobject

Included only when editing as { type: 'data_diff', data: <before/after changes> } for approval display.

audit_frontend_resourceobject

Records the before/after difference of the operation; not a business field.

company_emailstring

Company contact email; omitted when empty

company_telstring

Company contact phone; omitted when empty

company_faxstring

Company fax number; omitted when empty

social_mediastring

Social media info; omitted when empty

langstring

Options come from a backend data dictionary

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

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