Skip to main content
PUT
/
engagement
/
news
/
{newsId}
{
  "startSendingAfter": "2023-11-07T05:31:56Z",
  "stopSendingAfter": "2023-11-07T05:31:56Z",
  "pageRules": [
    {
      "pageFilter": "<string>"
    }
  ],
  "frequencyDays": 123,
  "frequency": "<string>",
  "frequencyType": "<string>",
  "format": "<string>",
  "sent": true,
  "sound": true,
  "newTrigger": true,
  "tags": [
    "<string>"
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "targetAudience": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "hidden": true,
  "name": "<string>",
  "type": "<string>",
  "_id": "<string>",
  "searchContent": "<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>",
  "subType": "<string>",
  "sender": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gleap.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
project
string
required

Path Parameters

​
newsId
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
​
pageFilterType
enum<string>
required
Available options:
is,
contains,
isnot,
notcontains,
startswith,
endswith,
empty,
notempty
​
frequencyDays
number<double>
required
​
frequency
string
required
​
frequencyType
string
required
​
format
string
required
​
sent
boolean
required
​
sound
boolean
required
​
newTrigger
boolean
required
​
tags
string[]
required
​
updatedAt
string<date-time>
required
​
status
string
required
​
targetAudience
string
required
​
createdAt
string<date-time>
required
​
hidden
boolean
required
​
name
string
required
​
type
string
required
​
_id
string
required
​
searchContent
string
​
emailTemplate
object
​
sourceOutbound
object
​
trigger
any
​
pageFilterDelay
number<double>
​
pageFilter
string
​
eventTriggerDelay
number<double>
​
eventTrigger
string
​
actionType
string
​
sentAt
string<date-time>
​
stats
any
​
subject
any
​
coverImageUrl
string
​
subType
string
​
sender
object
​
project
object
​
data
any
​
conditions
any
​
config
any
​
message
any
​
aiSummaryOutdated
boolean
​
aiSummary
string
​
organisation
object
​
createdBy
object