Create SaaS Announcement

Creates a tenant announcement; once submitted it enters the review workflow.

Request parameters

Required: review_url (review callback URL), reason (remark), show_begin (display start time), show_end (display end time), title (title), announcement_type (announcement type)
title, description, rich_desc, button, and conditions are JSON-encoded strings, not nested objects.
See the field descriptions for each field's format, allowed values, and business meaning.

Business notes

A submitted announcement is not shown to customers immediately; it takes effect only after approval. The caller must supply review_url, the callback address used to redirect to or return the review result once review completes.

Risk warning

This operation creates customer-facing announcement content. Confirm the title, content, display channels, and effective period before calling.

Result

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

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

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

channelobject

Display channels. The frontend sets <platform>: true for each selected platform and, for ios, android, pc, and port_pc, optional <platform>_low and <platform>_up version bounds.

Child attributes

listarray<string>

Selected platforms: all, ios, android, pc, port_pc, h5, or web. The frontend defaults to ["all"].

closableboolean

Whether the customer can close the announcement. The frontend defaults to false.

prioritynumber

Priority. A larger value means a higher priority. The frontend defaults to 0.

reasonstringrequired

Remark

show_beginnumberrequired

Display start time, as a Unix timestamp in seconds.

show_endnumberrequired

Display end time, as a Unix timestamp in seconds.

titlestringrequired

Title, as a JSON-encoded multilingual object.

descriptionstring

Content, as a JSON-encoded multilingual object. The frontend sends {} when empty.

rich_descstring

Rich-text content, as a JSON-encoded multilingual object. The frontend sends {} when empty.

conditionsstring

Display conditions, as a JSON-encoded object. Depending on announcement_type, the frontend fills markets, positions, and counter_ids.

announcement_typenumberrequired

Announcement type. Values come from the announcement_types reference options.

linkstring

Redirect link

statusnumber

Enable status. Values come from the announcement_global_status reference options.

buttonstring

Button text, as a JSON-encoded multilingual object.

user_scopeobject

Target user scope.

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 context submitted by the frontend for the audit log, containing before and value.

review_urlstringrequired

Callback URL supplied by the caller for redirecting or returning the review result after approval completes.

Responses

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