← Back to all endpoints
PUT /notifications/preferences auth required

Headers

NameRequiredDescription
X-Session-Token Yes -

Request Body

Content-TypeFormat
application/json object

Schema

FieldTypeRequiredDescription
enabled boolean No Master switch for browser push notifications
messages_enabled boolean No Notify for new messages
vertretungsplan_enabled boolean No Notify for new matching Vertretungsplan entries
vertretungsplan_class_mode string No Class scope: own, selected, or all
vertretungsplan_classes array[string] No Classes used when class mode is selected
start_time string No Local time at which polling may start
end_time string No Local time at which polling may stop
poll_interval_minutes integer No Poll Interval Minutes
timezone string No IANA timezone used for the polling window
show_preview boolean No Include sender and subject in push notifications

Example

{ "enabled": true, "messages_enabled": true, "vertretungsplan_enabled": true, "vertretungsplan_class_mode": "<Class scope: own, selected, or all>", "vertretungsplan_classes": [], "start_time": "<Local time at which polling may start>", "end_time": "<Local time at which polling may stop>", "poll_interval_minutes": 0, "timezone": "<IANA timezone used for the polling window>", "show_preview": true }

Responses

200 Successful Response
422 Validation Error
{ "detail": [] }