NotificationCreateDto

Endpoints · All schemas

Field	Required	Description
data	No	Additional notification data
description	No	Notification description
level	No	See definition below
readAt	No	Date when notification was read
title	Yes	Notification title
type	No	See definition below
userId	Yes	User ID to send notification to

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: NotificationLevel, NotificationType

{
  "properties": {
    "data": {
      "additionalProperties": {},
      "description": "Additional notification data",
      "type": "object"
    },
    "description": {
      "description": "Notification description",
      "nullable": true,
      "type": "string"
    },
    "level": {
      "$ref": "#/components/schemas/NotificationLevel"
    },
    "readAt": {
      "description": "Date when notification was read",
      "example": "2024-01-01T00:00:00.000Z",
      "format": "date-time",
      "nullable": true,
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "type": "string"
    },
    "title": {
      "description": "Notification title",
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/NotificationType"
    },
    "userId": {
      "description": "User ID to send notification to",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  },
  "required": [
    "title",
    "userId"
  ],
  "type": "object"
}