Skip to main content

UpdateNotificationPreferencesRequest

Request to replace the current user's notification delivery preferences.

channels object

Global per-channel delivery toggles.

dashboardboolean

Whether notifications are delivered to the in-app dashboard feed.

emailboolean

Whether notifications are delivered by email.

categories objectnullable

Per-category channel overrides. Required, and must contain an entry for every notification category with non-null channel preferences; this is a full replacement, not a partial update.

Billing object

Delivery channels for billing notifications.

dashboardboolean

Whether notifications are delivered to the in-app dashboard feed.

emailboolean

Whether notifications are delivered by email.

Projects object

Delivery channels for project notifications.

dashboardboolean

Whether notifications are delivered to the in-app dashboard feed.

emailboolean

Whether notifications are delivered by email.

Vms object

Delivery channels for virtual machine notifications.

dashboardboolean

Whether notifications are delivered to the in-app dashboard feed.

emailboolean

Whether notifications are delivered by email.

Network object

Delivery channels for network notifications.

dashboardboolean

Whether notifications are delivered to the in-app dashboard feed.

emailboolean

Whether notifications are delivered by email.

Security object

Delivery channels for security notifications.

dashboardboolean

Whether notifications are delivered to the in-app dashboard feed.

emailboolean

Whether notifications are delivered by email.

UpdateNotificationPreferencesRequest
{
"channels": {
"dashboard": true,
"email": true
},
"categories": {
"Billing": {
"dashboard": true,
"email": true
},
"Projects": {
"dashboard": true,
"email": true
},
"Vms": {
"dashboard": true,
"email": true
},
"Network": {
"dashboard": true,
"email": true
},
"Security": {
"dashboard": true,
"email": true
}
}
}