{
"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>",
"_id": "<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
Update a news article.
Update an engagement news article. Any pending (not yet sent) deliveries for this engagement are discarded
and re-queued from the updated document. While an engagement is live, its audience, targeting and
scheduling fields cannot be changed (for fixed frequency engagements neither can its content); pause
it first or the request fails with 409. Setting status to live starts delivery. type, project,
organisation and createdBy are set server-side and ignored if supplied.
PUT
/
engagement
/
news
/
{newsId}
{
"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>",
"_id": "<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
Path Parameters
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