Skip to content
Combination Rule

Edit Market Rule

Edit a market (combination) rule.

Request parameters

  • Required: id (id of the rule to edit).
  • Optional: name, market, merge, grey_market_merge, items (same as the create endpoint).
  • Request fields are derived from the entity returned by "Market Rule Detail".

Result

On success, the rule is updated and the response data is an empty object.

PUThttps://b-api.longbridge.xyz/billing/market/rule

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Id of the market rule to edit.

namestring

Rule name.

marketstring

Applicable market, e.g. US, HK.

mergestring

Whether to merge billing: 1 merge, 0 do not merge.

grey_market_mergestring

Whether grey-market trades are merged for billing: 1 merge, 0 do not merge.

itemsarray<object>

List of rule items. Each item has order_sources (order source list) and merge_tag.

Child attributes
order_sourcesarray<string>
merge_taginteger

Responses

HTTP 200The request was processed successfully. The response data is an empty object.
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