{
"startSendingAfter": "2023-11-07T05:31:56Z",
"stopSendingAfter": "2023-11-07T05:31:56Z",
"pageRules": [
{
"pageFilterType": "is",
"pageFilter": "<string>"
}
],
"pageFilterType": "is",
"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>"
}
}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
{
"startSendingAfter": "2023-11-07T05:31:56Z",
"stopSendingAfter": "2023-11-07T05:31:56Z",
"pageRules": [
{
"pageFilterType": "is",
"pageFilter": "<string>"
}
],
"pageFilterType": "is",
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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
Show child attributes
Show child attributes
Available options:
is, contains, isnot, notcontains, startswith, endswith, empty, notempty Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes