POST
/
news

Authorizations

Authorization
string
headerrequired

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

Headers

project
string
required

Body

application/json

Data Transfer Object (DTO) for creating or updating news.

name
string
required

The name property is intended for internal use only.

status
enum<string>

The status of the news (draft or live).

Available options:
draft,
live
actionType
enum<string>

The type of action (nonotify_news or notification).

Available options:
nonotify_news,
notification
subject
object
required

The subject of the news, which is a localized string.

markdownMessage
object
required

The Markdown content of the news message, which is a localized string.

coverImageUrl
string
required

The URL for the news cover image (up to 255 characters).

sender
string
required

The sender of the news.

targetAudience
enum<string>

The target audience for the news (user, guest, or all).

Available options:
user,
guest,
all

Response

200 - application/json

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
sourceOutbound
object
aiSummaryOutdated
boolean
aiSummary
string
trigger
any
organisation
object
project
object
pageFilterDelay
number
pageFilter
string
eventTriggerDelay
number
eventTrigger
string
actionType
string
sentAt
string
message
any
subject
any
coverImageUrl
string
sender
object
config
any
data
any
conditions
any[]
required
targetAudience
string
required
frequencyDays
number
required
frequency
string
required
frequencyType
string
required
format
string
required
sent
boolean
required
sound
boolean
required
newTrigger
boolean
required
status
string
required
name
string
required
type
string
required
IntroductionGet all news articles