Enable/Disable My Broker

Lists an own-side broker up or takes it down, controlling whether it is enabled for business use.

Request parameters

Required: brokers_my_id (own-side broker record ID), is_valid (whether to list up)
Optional: audit_frontend_resource (caller-provided audit context)
See the field descriptions for the format, value range, and business meaning of each field.

Business notes

When taken down, the broker is no longer available externally; listing it up restores availability.

Risk warning

This operation changes the live listed/unlisted state of the broker and affects its availability in transfer and related business. Confirm the target record before calling.

Result

On success, the broker's listed/unlisted state is updated. The resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/atm/stand_up_down_brokers_my

Authorization

AuthorizationstringheaderRequired

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

Permission

cmbc.broker_my

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

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).

Values

1: Stand up
0: Stand down

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.