Open Inventory / Docs
EndpointsNotificationsNotificationsPreferences

Update personal notification preferences

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

PATCH
/notifications/preferences

External channels default off and must be explicitly enabled. Destination URLs remain server environment variables and are never accepted by this endpoint.

Authorization

adminSession
cookieauthjs.session-token<token>

Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
enabledEventTypes?array<>
Itemsitems <= 4
frequency?string
Value in"daily""immediate"
digestHour?integer
Range0 <= value <= 23
timezone?string
Lengthlength <= 80
locale?string
Value in"en""de"
cooldownHours?integer
Range1 <= value <= 720
lowStockThresholdPercent?integer
Range1 <= value <= 500
expiryWindowDays?integer
Range0 <= value <= 3650
expiryFieldKey?string
Match^[a-z][a-z0-9_]{0,63}$
Lengthlength <= 64
maintenanceWindowDays?integer
Range0 <= value <= 3650
maintenanceFieldKey?string
Match^[a-z][a-z0-9_]{0,63}$
Lengthlength <= 64
returnDueWindowDays?integer
Range0 <= value <= 365
emailEnabled?boolean
Defaultfalse
pushEnabled?boolean
Defaultfalse
slackEnabled?boolean
Defaultfalse
teamsEnabled?boolean
Defaultfalse
webhookEnabled?boolean
Defaultfalse

Response Body

Preferences updated

Example Request
curl -X PATCH 'https://inventory.example.com/api/v1/notifications/preferences' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty