POST
/
news
curl --request POST \
  --url https://api.gleap.io/v3/news \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'project: <project>' \
  --data '{
  "name": "<string>",
  "status": "draft",
  "actionType": "nonotify_news",
  "subject": {
    "localized": {}
  },
  "markdownMessage": {
    "localized": {}
  },
  "coverImageUrl": "<string>",
  "sender": "<string>",
  "config": {
    "pinned": true
  },
  "targetAudience": "user"
}'
{
  "emailTemplate": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "sourceOutbound": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "trigger": "<any>",
  "pageFilterDelay": 123,
  "pageFilter": "<string>",
  "eventTriggerDelay": 123,
  "eventTrigger": "<string>",
  "actionType": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "stats": "<any>",
  "subject": "<any>",
  "coverImageUrl": "<string>",
  "sender": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "data": "<any>",
  "config": "<any>",
  "message": "<any>",
  "aiSummaryOutdated": true,
  "aiSummary": "<string>",
  "organisation": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "createdBy": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "pageFilterType": "is",
  "frequencyDays": 123,
  "frequency": "<string>",
  "frequencyType": "<string>",
  "format": "<string>",
  "sent": true,
  "hidden": true,
  "sound": true,
  "newTrigger": true,
  "status": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "conditions": [
    "<any>"
  ],
  "targetAudience": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "type": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
project
string
required

Body

application/json
​
name
string
required

The name property is intended for internal use only.

​
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.

​
config
object
required

The configuration of the news.

​
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
​
targetAudience
enum<string>

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

Available options:
user,
guest,
all

Response

200 - application/json
Ok
​
pageFilterType
enum<string>
required
Available options:
is,
contains,
isnot,
notcontains,
startswith,
endswith,
empty,
notempty
​
frequencyDays
number
required
​
frequency
string
required
​
frequencyType
string
required
​
format
string
required
​
sent
boolean
required
​
hidden
boolean
required
​
sound
boolean
required
​
newTrigger
boolean
required
​
status
string
required
​
updatedAt
string
required
​
conditions
any[]
required
​
targetAudience
string
required
​
createdAt
string
required
​
name
string
required
​
type
string
required
​
emailTemplate
object
​
sourceOutbound
object
​
trigger
any
​
pageFilterDelay
number
​
pageFilter
string
​
eventTriggerDelay
number
​
eventTrigger
string
​
actionType
string
​
sentAt
string
​
stats
any
​
subject
any
​
coverImageUrl
string
​
sender
object
​
project
object
​
data
any
​
config
any
​
message
any
​
aiSummaryOutdated
boolean
​
aiSummary
string
​
organisation
object
​
createdBy
object