Update User Rate

Edit a user execution spread rate, used to change its effective time, currency pair, and spread settings.

Request parameters

Required: id (config ID), start_time, end_time, from_currency (source currency), to_currency (target currency), default_effective (whether it is effective by default, with no time window)
Optional: action_user, channel_name, is_default, rate_source, rate_use_in, reference_rate, service_strategy, spread_mode, spread_value (spread-band configuration), audit_frontend_resource (caller-provided audit-log payload)
See each field's definition for its format, value range, and business meaning.

Business notes

When default_effective is true there is no time window, and start_time/end_time are fixed to '0'; otherwise they carry the effective range as unix seconds.

Risk warning

This operation changes a user execution spread rate, directly affecting the executed FX prices for the relevant user. Confirm the target record and parameters before calling.

Result

On success the user execution spread rate is updated; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/forex/user_rate_update

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.fee_update

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

Request body application/json

idstringrequired

Config ID associated with this request.

action_userstring

action_user. A free-form value (not an enum); provide the actual business value.

channel_namestring

Removed before submission (not sent) when service_strategy=BATCH (batch strategy).

end_timestringrequired

For a custom effective period, pass the range picker's end_time as a Unix timestamp in seconds. For the default period, pass 0.

start_timestringrequired

Same logic as end_time.

from_currencystringrequired

This field is required.

to_currencystringrequired

This field is required.

is_defaultstring

is_default. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

rate_sourcestring

rate_use_instring

rate_use_in. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

reference_ratestring

service_strategystring

spread_modestring

spread_mode. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

spread_valuearray<string>

Array elements {start_value, end_value}, split from the request field range_value interval.

default_effectivestringrequired

This field is required.

Values

true: Long-term (no time window)
false: Time period

audit_frontend_resourceobject

Provides audit context for this operation.

Responses

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