Skip to content
Subscription Record Synchronization

Create OB Sync Record

Creates an OB subscription synchronization record to sync subscription records to the target channel; also supports in-row retry from the list.

Request parameters

  • Required: counter_id (security code), records (sync record list), records[].channel (source channel), records[].method (subscription method), records[].ratio (subscription ratio), records[].target_method (target subscription method), records[].target_ratio (target subscription ratio), is_retry (whether this is a retry)
  • records[].channel must come from the origin_channel of the security's existing subscription records; it is not a fixed lb.
  • See each field description for its format, value range, default behavior, and business meaning.

Business notes

This endpoint is shared by both the "create" action and the in-row "retry" action of subscription record synchronization; when is_retry is true, it retries synchronization for existing records.

Risk warning

This operation creates and triggers subscription record synchronization, affecting downstream subscription data. Verify the security and sync record content before calling.

Result

On success, the OB subscription sync record is created; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/ob/create/record

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.ob_manage

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

Request body application/json

counter_idstringrequired

Counter ID. Counter ID associated with this request. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

recordsarray<object>required

Sync Records. Each item is a channel sync configuration; on create it is the selected records (rows with an empty channel filtered out), and on retry it is a single-element array of the current row's data.

Child attributes
channelstringrequired

Origin Channel. This field is required. Must be the record's origin_channel (from the OB subscription sync record rows filtered by counter_id), not a fixed value such as lb.

methodintegerrequired

Subscription Method.

Allowed values: 1 Financing, 2 Cash

Values
1
Financing
2
Cash
ratiostringrequired

Ratio. A percentage value; sent as a string without the % sign, e.g. "100" means 100%.

target_methodintegerrequired

Target Method.

Allowed values: 1 Financing, 2 Cash

Values
1
Financing
2
Cash
target_ratiostringrequired

Target Ratio. Target subscription ratio, a percentage value; sent as a string without the % sign.

is_retrybooleanrequired

Is Retry. Send false for a create operation; send true for a "Retry" operation.

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