Skip to content
Longport WhaleLongport Whale
My Broker

Enable/Disable My Broker

Called after confirmation. This changes the broker's live listing status.

Request parameters

  • Required: brokers_my_id (My Broker Record ID), is_valid (Is Valid/Enabled)
  • Optional: 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/stand_up_down_brokers_my

Authorization

Authorizationstringheadercmbc.broker_myRequired

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

Request body application/json

brokers_my_idstringrequired

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

is_validintegerrequired

Is Valid/Enabled. 1 = listed (Stand up), 0 = delisted (Stand down).

Allowed values:

  • 1 - Stand up
  • 0 - Stand down

10

audit_frontend_resourceobject

Audit Context. Auto-attached by the client, containing only the $behavior text (list/delist prompt); not a business field.

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