Create a new engagement news article

Create a news article for a project. subject.localized is required. 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

200

{
  "startSendingAfter": "2023-11-07T05:31:56Z",
  "stopSendingAfter": "2023-11-07T05:31:56Z",
  "pageRules": [
    {
      "pageFilter": "<string>"
    }
  ],
  "frequencyDays": 123,
  "frequency": "<string>",
  "frequencyType": "<string>",
  "sent": true,
  "sound": true,
  "newTrigger": true,
  "format": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "targetAudience": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "hidden": true,
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "type": "<string>",
  "emailTemplate": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "sourceOutbound": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "trigger": "<unknown>",
  "pageFilterDelay": 123,
  "pageFilter": "<string>",
  "eventTriggerDelay": 123,
  "eventTrigger": "<string>",
  "actionType": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "stats": "<unknown>",
  "subject": "<unknown>",
  "coverImageUrl": "<string>",
  "slug": "<string>",
  "subType": "<string>",
  "sender": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "searchContent": "<string>",
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "data": "<unknown>",
  "conditions": "<unknown>",
  "config": "<unknown>",
  "message": "<unknown>",
  "aiSummaryOutdated": true,
  "aiSummary": "<string>",
  "organisation": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "createdBy": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project · string · required

Body

application/json

The body is of type any.

Response

200 - application/json

Ok

Generic types for Document:

• T - the type of _id
• TQueryHelpers - Object with any helpers that should be mixed into the Query type
• DocType - the type of the actual Document created

startSendingAfter · string<date-time> · required

stopSendingAfter · string<date-time> · required

pageRules · object[] · required

Show child attributes

pageFilterType · enum<string> · required

Available options: is, contains, isnot, notcontains, startswith, endswith, empty, notempty

frequencyDays · number<double> · required

frequency · string · required

frequencyType · string · required

sent · boolean · required

sound · boolean · required

newTrigger · boolean · required

format · string · required

updatedAt · string<date-time> · required

status · string · required

targetAudience · string · required

createdAt · string<date-time> · required

hidden · boolean · required

tags · string[] · required

name · string · required

type · string · required

emailTemplate · object

Show child attributes

sourceOutbound · object

Show child attributes

trigger · any

pageFilterDelay · number<double>

pageFilter · string

eventTriggerDelay · number<double>

eventTrigger · string

actionType · string

sentAt · string<date-time>

stats · any

subject · any

coverImageUrl · string

slug · string

subType · string

sender · object

Show child attributes

searchContent · string

project · object

Show child attributes

data · any

conditions · any

config · any

message · any

aiSummaryOutdated · boolean

aiSummary · string

organisation · object

Show child attributes

createdBy · object

Show child attributes