---
title: "Create a new engagement news article"
method: POST
path: "/engagement/news"
tags: ["Engagement News"]
---

# Create a new engagement news article

`POST /engagement/news`

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.

## Headers

- `project` string, required

## Request body

- unknown

## Response `200`

Ok

- OutboundDocument
  - `emailTemplate` object
    - `isValid` object
    - `createFromHexString` object
    - `createFromTime` object
    - `generate` object
    - `cacheHexString` unknown
    - `prototype` string
  - `sourceOutbound` object
    - `isValid` object
    - `createFromHexString` object
    - `createFromTime` object
    - `generate` object
    - `cacheHexString` unknown
    - `prototype` string
  - `trigger` unknown
  - `pageFilterDelay` number, double
  - `pageFilter` string
  - `eventTriggerDelay` number, double
  - `eventTrigger` string
  - `actionType` string
  - `sentAt` string, date-time
  - `stats` unknown
  - `subject` unknown
  - `coverImageUrl` string
  - `slug` string
  - `subType` string
  - `sender` object
    - `isValid` object
    - `createFromHexString` object
    - `createFromTime` object
    - `generate` object
    - `cacheHexString` unknown
    - `prototype` string
  - `searchContent` string
  - `project` object
    - `isValid` object
    - `createFromHexString` object
    - `createFromTime` object
    - `generate` object
    - `cacheHexString` unknown
    - `prototype` string
  - `data` unknown
  - `conditions` unknown
  - `config` unknown
  - `message` unknown
  - `aiSummaryOutdated` boolean
  - `aiSummary` string
  - `organisation` object
    - `isValid` object
    - `createFromHexString` object
    - `createFromTime` object
    - `generate` object
    - `cacheHexString` unknown
    - `prototype` string
  - `createdBy` object
    - `isValid` object
    - `createFromHexString` object
    - `createFromTime` object
    - `generate` object
    - `cacheHexString` unknown
    - `prototype` string
  - `startSendingAfter` string, date-time, required
  - `stopSendingAfter` string, date-time, required
  - `pageRules` object[], required
    - `pageFilter` string
    - `pageFilterType` 'is' | 'contains' | 'isnot' | 'notcontains' | 'startswith' | 'endswith' | 'empty' | 'notempty', required
  - `pageFilterType` 'is' | 'contains' | 'isnot' | 'notcontains' | 'startswith' | 'endswith' | 'empty' | 'notempty', required
  - `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

---

[API](https://skmtc.net/gleap/apis/gleap-server.md) · [All operations](https://skmtc.net/gleap/apis/gleap-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gleap/gleap-server/revisions/fe2dff9fb04b/schema)