Skip to content
Longport Whale
Sending Brokerage Firm

Create/Modify Rival Broker Info

Submitted from the inline "Create/Edit" drawer in the Sending Brokerage Firm list. name/app_name are multilingual fields split into _en/_cn/_hk before submission; is_has_attachment and show_name are dropdown enums (from the refs atm_brokers_attachment and atm_brokers_show_name respectively); id is included only when editing. This changes real broker configuration.

POSThttps://b-api.longbridge.xyz/atm/create_modify_brokers_v2

Authorization

AuthorizationstringheaderRequired

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. A dropdown selection from ref atm_market; disabled and not editable when editing.

name_enstringrequired

Channel Broker (English)

name_cnstringrequired

Channel Broker (Simplified Chinese)

name_hkstringrequired

Channel Broker (Traditional Chinese)

app_name_enstringrequired

Broker App Name (English)

app_name_cnstringrequired

Broker App Name (Simplified Chinese)

app_name_hkstringrequired

Broker App Name (Traditional Chinese)

stock_limitintegerrequired

Stock Number Limited

codestringrequired

Code

contactstringrequired

Contact

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.

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

iconstring

Broker Logo

show_namestringrequired

Display Name of Our Broker. A radio field; the value is the key from ref atm_brokers_show_name.

websitestring

Website Address. Required when is_has_attachment indicates no attachment.

priorityintegerrequired

Priority. Value range 0-999.

statestringrequired

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

file_listarray<string>

Attachment File List. An array of file keys (uploadKey/key) produced by the front-end review_urls upload component.

audit_frontend_resourceobject

Frontend Audit Resource. Auto-appended by the front end for audit-log display; not a business field.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs