Create/Modify My Broker Info

Uses the V3 endpoint. Includes id when editing and omits it when creating. This changes live broker configuration.

Request parameters

Required: market (Market), code (Code), name (Name of channel broker), company_name (Name of Counter Company), contact (Contact), contact_email (Contact Email), contact_phones (Contact Phone)
Optional: id (Broker Record ID), account (Broker Account), 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_my_v3

Authorization

Authorizationstringheadercmbc.broker_myRequired

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

Request body application/json

idstring

Broker Record ID. Provided only when editing an existing record; not sent when creating.

marketstringrequired

Market. Dropdown selection. This field is disabled and cannot be modified when editing.

Allowed values:

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

uscnhksg

codestringrequired

Code. Specifies Code. This field is required.

namestringrequired

Name of channel broker. Specifies Name of channel broker. This field is required.

company_namestringrequired

Name of Counter Company. Specifies Name of Counter Company. This field is required.

accountstring

Broker Account. Specifies Broker Account.

contactstringrequired

Contact. Specifies Contact. This field is required.

contact_emailstringrequired

Contact Email. Specifies Contact Email. This field is required.

contact_phonesarray<string>required

Contact Phone. An array of { contact_phone: string }; multiple contact phones can be added or removed dynamically, and each must match the regex ^[A-Za-z0-9,.-+\s]+$.

audit_frontend_resourceobject

Audit Context. An audit-trail field automatically appended by the client, containing $action/$behavior and the original field values prior to editing; not a business parameter.

Responses

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