Sign in
OpenAPI 3.0.02026-08-12277306567.6 KB

fe2dff9fb04b

Engagement News

Create a new engagement news article

Create a news article for a project. subject is required, either as { localized: { en: "..." } } or as a bare per-language map { en: "..." } (canonicalized server-side; same for message and markdownMessage). sender defaults to the authenticated user and trigger defaults to sessionStarted/firstoccured when omitted. Instead of message you may send markdownMessage (localized markdown), which is converted to rich text server-side. searchContent is computed server-side and ignored if supplied. Creating a CHANGELOG news item with status: "live" immediately sends changelog notification emails to subscribers.

post/engagement/news

Headers

projectstring required

Request body

{"stackTrail":"paths:/engagement/news:post:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

Ok

{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:trigger","oasType":"schema","type":"unknown"}
pageFilterDelaynumber double
pageFilterstring
eventTriggerDelaynumber double
eventTriggerstring
actionTypestring
sentAtstring date-time
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:stats","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:subject","oasType":"schema","type":"unknown"}
coverImageUrlstring
slugstring
subTypestring
searchContentstring
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:conditions","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:config","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:message","oasType":"schema","type":"unknown"}
aiSummaryOutdatedboolean
aiSummarystring
startSendingAfterstring date-time required
stopSendingAfterstring date-time required
pageFilterType'is' | 'contains' | 'isnot' | 'notcontains' | 'startswith' | 'endswith' | 'empty' | 'notempty' required
frequencyDaysnumber double required
frequencystring required
frequencyTypestring required
sentboolean required
soundboolean required
newTriggerboolean required
formatstring required
updatedAtstring date-time required
statusstring required
targetAudiencestring required
createdAtstring date-time required
hiddenboolean required
tagsstring[] required
namestring required
typestring required