Skip to content
BleemeoBleemeo

Mark all news as read

POST
/v1/news/mark_read/
curl --request POST \
  --url https://example.com/v1/news/mark_read/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "description": "example", "category": "feature", "image": "https://example.com", "banner_image": "https://example.com", "publish_at": "2026-04-15T12:00:00Z", "expire_at": "2026-04-15T12:00:00Z", "cta_label": "example", "cta_url": "example", "created_at": "2026-04-15T12:00:00Z" }'

Mark every currently visible news item as read for the requesting user.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
title
required
string
<= 50 characters
description
string
category
  • feature - Feature
  • improvement - Improvement
  • fix - Fix
  • tip - Tip
  • event - Event
string
Allowed values: feature improvement fix tip event
image
string format: uri
nullable
banner_image
string format: uri
nullable
active
required
boolean
publish_at

A published news only becomes visible once this date is reached.

string format: date-time
expire_at

Once this date is reached, the news is no longer visible.

string format: date-time
nullable
cta_label
string
<= 50 characters
cta_url

Call-to-action target: a full URL (https://…, opens in a new tab) or a panel-relative path (e.g. /settings/cloud, opens in the app).

string
<= 200 characters
read
required
boolean
my_reaction
required
string
nullable
reactions
required
object
key
additional properties
integer
created_at
string format: date-time
modified_at
required
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
title
required
string
<= 50 characters
description
string
category
  • feature - Feature
  • improvement - Improvement
  • fix - Fix
  • tip - Tip
  • event - Event
string
Allowed values: feature improvement fix tip event
image
string format: uri
nullable
banner_image
string format: uri
nullable
active
required
boolean
publish_at

A published news only becomes visible once this date is reached.

string format: date-time
expire_at

Once this date is reached, the news is no longer visible.

string format: date-time
nullable
cta_label
string
<= 50 characters
cta_url

Call-to-action target: a full URL (https://…, opens in a new tab) or a panel-relative path (e.g. /settings/cloud, opens in the app).

string
<= 200 characters
read
required
boolean
my_reaction
required
string
nullable
reactions
required
object
key
additional properties
integer
created_at
string format: date-time
modified_at
required
string format: date-time

Example 

{
  "category": "feature"
}