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. News items always use a dynamic audience: frequencyType: "fixed" and csvContacts are ignored. Target people with targetAudience and conditions instead.

post/engagement/news

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/engagement/news
  • Auth
    HTTP bearer

Headers

projectstring required

Request body

unknown required

Response

Ok

commentEmailOptOutsunknown
trackingunknown
surveyunknown
aiSummaryAttemptedAtstring date-time
aiSummaryDataunknown
triggerunknown
pageFilterDelaynumber double
pageFilterstring
eventTriggerDelaynumber double
eventTriggerstring
actionTypestring
sentAtstring date-time
statsunknown
coverImageUrlstring
slugstring
subTypestring
emailCategorystring
preheaderunknown
subjectunknown
emailStylestring
kaiunknown
searchContentstring
dataunknown
conditionsunknown
configunknown
messageunknown
aiSummaryOutdatedboolean
aiSummarystring
startSendingAfterstring date-time required
dropIfConditionsFailboolean 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
hiddenboolean required
statusstring required
targetAudiencestring required
updatedAtstring date-time required
createdAtstring date-time required
tagsstring[] required
namestring required
typestring required

Changes

No recorded changes to this operation across all 56 revisions of this API.