Create/Modify Rival Broker Info

Cross-check with the audit template. name and app_name are localized fields split into _en, _cn, and _hk before submission. is_has_attachment uses atm_brokers_attachment reference data. Include id only when editing. This changes live broker configuration.

Request parameters

Required: market (Market), name_en (Channel Broker (English)), name_cn (Channel Broker (Simplified Chinese)), name_hk (Channel Broker (Traditional Chinese)), app_name_en (Broker App Name (English)), app_name_cn (Broker App Name (Simplified Chinese)), app_name_hk (Broker App Name (Traditional Chinese)), stock_limit (Stock Number Limited), code (Code), contact (Contact), is_has_attachment (Any Attachment), tpl_email (Template Key for Transfer Email), show_name (Display Name of Our Broker), priority (Priority), state (State)
Optional: id (Rival Broker Record ID), contact_phone (Contact Phone), contact_email (Contact Email), icon (Broker Logo), website (Website Address), file_list (Attachment File List), audit_frontend_resource (Audit Context)
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.longbridge.xyz/atm/create_modify_brokers_v2

Authorization

Authorizationstringheadercmbc.broker_rivalRequired

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

Request body application/json

idstring

Rival Broker Record ID. Passed only when editing an existing record; omitted when creating.

marketstringrequired

Market. Dropdown value from select. The field is disabled and cannot be changed when editing.

Allowed values:

us - US Market
cn - CN Market
hk - HK Market
sg - SG Market

uscnhksg

name_enstringrequired

Channel Broker (English). Specifies Channel Broker (English). This field is required.

name_cnstringrequired

Channel Broker (Simplified Chinese). Specifies Channel Broker (Simplified Chinese). This field is required.

name_hkstringrequired

Channel Broker (Traditional Chinese). Specifies Channel Broker (Traditional Chinese). This field is required.

app_name_enstringrequired

Broker App Name (English). Specifies Broker App Name (English). This field is required.

app_name_cnstringrequired

Broker App Name (Simplified Chinese). Specifies Broker App Name (Simplified Chinese). This field is required.

app_name_hkstringrequired

Broker App Name (Traditional Chinese). Specifies Broker App Name (Traditional Chinese). This field is required.

stock_limitintegerrequired

Stock Number Limited. Specifies Stock Number Limited. This field is required.

codestringrequired

Code. Specifies Code. This field is required.

contactstringrequired

Contact. Specifies Contact. This field is required.

is_has_attachmentstringrequired

Any Attachment. A radio field whose value comes from the keys of ref atm_brokers_attachment (e.g. 1=has attachment / 0=no attachment; the exact enum is determined by the ref). When it is 1, website is optional and contact_phone/contact_email are required; for other values, the opposite applies.

Allowed values:

1 - Yes
0 - No

10

contact_phonestring

Contact Phone. Required when is_has_attachment indicates an attachment is present; must match the regex ^[A-Za-z0-9,.-+\s]+$.

contact_emailstring

Contact Email. Required when is_has_attachment indicates there is an attachment; must be in email format.

tpl_emailstringrequired

Template Key for Transfer Email. Specifies Template Key for Transfer Email. This field is required.

iconstring

Broker Logo. Specifies Broker Logo.

show_namestringrequired

Display Name of Our Broker. A radio field.

Allowed values:

1 - Name Of Counter Company
0 - Name Of Channel Broker

10

websitestring

Website Address. Required when is_has_attachment indicates no attachment.

priorityintegerrequired

Priority. Processing priority. Interpret the value and sort order according to the allowed-value definitions. This field is required.

statestringrequired

State. 1 = Enable, 2 = Disable; defaults to 1.

Allowed values:

1 - Enable
2 - Disable

12

file_listarray<string>

Attachment File List. Array of file keys returned after uploading files for review_urls.

audit_frontend_resourceobject

Audit Context. Auto-appended by the client for audit-log display; not a business field.

Responses

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