Skip to content
Longport WhaleLongport Whale
Announcement Management

Update Announcement Status

Updates the publish status of a specified announcement (for example, on-shelf or off-shelf).

Request parameters

  • Required: id (announcement ID), status (target status)
  • Optional: audit_frontend_resource (caller-provided audit context)
  • See the field descriptions for each field's format, allowed values, and business meaning.

Business notes

status switches the announcement's publish state, directly controlling whether it is visible to customers. audit_frontend_resource records before/after audit context for this change.

Risk warning

This operation changes the state of customer-facing announcement content. Confirm the target announcement and status before calling.

Result

On success the announcement status is updated; subsequent status and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/announcement/status

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_app.announcementsstock.market_holiday

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

Request body application/json

idnumberrequired

Announcement ID associated with this request.

statusnumberrequired

Target state to set through this request. This field is required.

audit_frontend_resourceobject

Provides audit context for this operation.

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