Update Deposit/Withdrawal Notice

Updates an existing deposit/withdrawal notice. The request body carries the target notice id at the top level, and all notice configuration fields are placed inside the config object.

Request parameters

Required: id (notice ID), config (notice configuration object).
Fields inside config are identical to those of "Create Deposit/Withdrawal Notice"; config.notice_type, config.title, and config.description are required.
config.title, config.description, and config.confirm_button_label are multi-language fields passed as JSON strings.
config.account_channel, config.region_ids, and config.region_bank_ids are multi-value fields passed as comma-separated strings.
config.show_begin and config.show_end are Unix timestamps in seconds.
audit_frontend_resource is caller-provided audit context (before/after comparison data). Optional.

Result

On success, the notice is updated. See the 200 response schema for returned data and subsequent state information.

PUThttps://b-api.longbridge.xyz/v1/portfolio/atm/notice

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Unique identifier of the deposit/withdrawal notice to update. This field is required.

configobjectrequired

Notice configuration object. Its fields are identical to those of "Create Deposit/Withdrawal Notice". This field is required.

Child attributes

notice_typestringrequired

Notice type. This field is required.

Allowed values:

1 - Deposit
2 - Withdrawal

1 · Deposit2 · Withdrawal

titlestringrequired

Multi-language title passed as a JSON string keyed by language code such as zh-CN, zh-HK, and en. This field is required.

descriptionstringrequired

Multi-language notice content passed as a JSON string. This field is required.

client_channelobject

Display channel configuration. A map from channel keys to booleans indicating whether the notice shows on that channel. Version-gated channels additionally carry <channel>_low and <channel>_up fields for the effective version range.

account_channelstring

Account channels the notice applies to. Multiple values are passed as a comma-separated string.

org_idsarray<string>

Target organization ID list. When omitted or empty, the notice applies to all available organizations by default.

app_idsarray<string>

List of apps the notice reaches.

region_idsstring

Bank account regions. Multiple values are passed as a comma-separated string.

region_bank_idsstring

Bank names (bank IDs). Multiple values are passed as a comma-separated string.

bank_operation_types_idstring

Deposit method.

remarkstring

Remarks.

show_begininteger

Time when the notice starts showing, as a Unix timestamp in seconds.

show_endinteger

Time when the notice stops showing, as a Unix timestamp in seconds.

linkstring

Redirect link opened when the notice is clicked.

client_display_waystring

How the notice is displayed on the client.

confirm_button_labelstring

Multi-language confirm button copy passed as a JSON string. Optional.

priorityinteger

Notice priority; a larger value means higher priority.

audit_frontend_resourceobject

Caller-provided audit context used to record before/after comparison information for the edit. Optional.

Responses

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