Update User Rate · Whale Docs

POSThttps://b-api.longbridge.xyz/forex/user_rate_update

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Config ID

action_userstring

Action User

channel_namestring

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

end_timestringrequired

End Time. When not default-effective (default_effective!=true), it is the unix seconds of the range picker's end_time; when default-effective it always passes '0'.

start_timestringrequired

Start Time. Same logic as end_time.

from_currencystringrequired

From Currency

to_currencystringrequired

To Currency

is_defaultstring

Is Default

rate_sourcestring

Rate Source

rate_use_instring

Rate Use In

reference_ratestring

Reference Rate

service_strategystring

Service Strategy

spread_modestring

Spread Mode

spread_valuearray<string>

Spread Value. Array elements {start_value, end_value}, split from the form's range_value interval.

default_effectivestringrequired

Default Effective

audit_frontend_resourceobject

Audit Frontend Resource. Not a business field.

Responses

HTTP 200No confirmable field definitions are available for the response yet.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/forex/user_rate_update' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "id": "1",
  "action_user": "",
  "channel_name": "",
  "end_time": "0",
  "start_time": "0",
  "from_currency": "USD",
  "to_currency": "HKD",
  "is_default": "true",
  "rate_source": "",
  "rate_use_in": "",
  "reference_rate": "",
  "service_strategy": "",
  "spread_mode": "",
  "spread_value": [
    {
      "start_value": "0",
      "end_value": ""
    }
  ],
  "default_effective": "true",
  "audit_frontend_resource": {}
}'

Response

{
  "code": 0,
  "message": null,
  "data": {}
}