News
Update a news article
PUT
/
news
/
{newsId}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
project
string
requiredPath Parameters
newsId
string
requiredBody
application/json
Data Transfer Object (DTO) for creating or updating news.
name
string
requiredThe 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
requiredThe subject of the news, which is a localized string.
markdownMessage
object
requiredThe Markdown content of the news message, which is a localized string.
coverImageUrl
string
requiredThe URL for the news cover image (up to 255 characters).
sender
string
requiredThe 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[]
requiredtargetAudience
string
requiredfrequencyDays
number
requiredfrequency
string
requiredfrequencyType
string
requiredformat
string
requiredsent
boolean
requiredsound
boolean
requirednewTrigger
boolean
requiredstatus
string
requiredname
string
requiredtype
string
required