Mark Notifications Read

POST

/v1/notifications/read

curl --request POST \
  --url https://api.cloud.agentums.ru/v1/notifications/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

• Прод

Гасит перечисленные уведомления; пустой список — все. Отдаёт свежий список со счётчиком, чтобы клиенту не приходилось делать второй запрос ради бейджа.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

NotificationsRead

object

ids

Ids

Array<string>

Example^generated

{
  "ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

200

Successful Response

Media typeapplication/json

NotificationList

object

items

required

Items

Array<object>

NotificationOut

object

body

Body

string

""

created_at

required

Created At

string format: date-time

id

required

Id

string format: uuid

kind

required

Kind

string

payload

Payload

object

key

additional properties

any

read_at

Any of:

string

string format: date-time

null

null

title

required

Title

string

unread

Unread

integer

0

Example

{
  "items": [
    {
      "body": "",
      "payload": {}
    }
  ],
  "unread": 0
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}