Skip to content
Subscription Record Synchronization

Create OB Sync Record

The endpoint shared by "New" and inline "Retry" on the Subscription Record Synchronization page, used to create an OB subscription sync record.

Request parameters

  • Required: counter_id (Counter ID), records (Sync Records), records[].channel (Origin Channel), records[].method (Subscription Method), records[].ratio (Ratio), records[].target_method (Target Method), records[].target_ratio (Target Ratio), is_retry (Is Retry)
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

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

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.ob_manage

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

Request body application/json

counter_idstringrequired

Counter ID. Counter ID associated with this request.

recordsarray<string>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.

records[].channelstringrequired

Origin Channel. This field is required.

records[].methodstringrequired

Subscription Method. This field is required.

records[].ratiostringrequired

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

records[].target_methodstringrequired

Target Method. This field is required.

records[].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