Skip to content
Announcement Management

Update SaaS Announcement

Edits an existing tenant announcement; once submitted it enters the review workflow.

Request parameters

  • Required: id (announcement ID), reason (remark), show_begin (display start time), show_end (display end time), title (title), announcement_type (announcement type)
  • See the field descriptions for each field's format, allowed values, and business meaning.

Business notes

The announcement is located by id. You can modify the title, content, display channels, priority, effective period, user scope, and other settings. Changes take effect only after review approval. review_url supplies the review callback address.

Risk warning

This operation modifies customer-facing announcement content. Confirm the target announcement and parameters before calling.

Result

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

POSThttps://b-api.lbkrs.com/sass/announcement/update

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_app.announcements

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

Request body application/json

idnumberrequired

Announcement ID

channelobject
Child attributes
listarray<string>

channel.list

closableboolean

Whether it is closable

prioritynumber

Priority (higher value = higher priority)

reasonstringrequired

Remark

show_beginnumberrequired

Display start time

show_endnumberrequired

Display end time

titlestringrequired

Title

descriptionstring

Content

rich_descstring

Rich-text content

conditionsstring

conditions

announcement_typenumberrequired

Announcement type

linkstring

Link

statusnumber

Whether it is enabled

buttonstring

Button text

user_scopeobject
Child attributes
org_idsarray<string>

user_scope.org_ids

app_idsarray<string>

user_scope.app_ids

account_channelboolean

user_scope.account_channel

user_clusterboolean

user_scope.user_cluster

audit_frontend_resourceobject

audit_frontend_resource

review_urlstring

Review callback URL

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