Sending Brokerage Firm

Delete Rival Broker

Called after confirmation in the delete pop-up. This permanently deletes live broker configuration.

Request parameters

Required: brokers_id (Rival Broker Record ID)
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/delete_brokers

Authorization

Authorizationstringheadercmbc.broker_rivalRequired

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

Request body application/json

brokers_idstringrequired

Rival Broker Record ID. Corresponds to the list row record.id.

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/atm/delete_brokers' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "brokers_id": "1"
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {}
}