Skip to content

Update Notification Preferences

PUT
/api/v1/notifications/preferences

Update the current user’s notification preferences.

Only fields present in the request body are updated.

Args: body: The fields to update. user: The authenticated user context.

Returns: The updated notification preferences.

Authorizations

Request Body required

Request body for updating notification preferences.

All fields are optional — only provided fields are updated.

Attributes: approval_requests: Toggle for approval request notifications. agent_alerts: Toggle for critical agent alert notifications. daily_brief: Toggle for daily brief notifications. quiet_hours_start: Hour (0-23) when quiet hours begin. quiet_hours_end: Hour (0-23) when quiet hours end. timezone: IANA timezone string.

object
agent_alerts
Any of:
boolean
approval_requests
Any of:
boolean
daily_brief
Any of:
boolean
quiet_hours_end
Any of:
integer
<= 23
quiet_hours_start
Any of:
integer
<= 23
timezone
Any of:
string
>= 1 characters <= 64 characters

Responses

200

Successful Response

Response body for notification preferences.

Attributes: approval_requests: Whether to receive approval request notifications. agent_alerts: Whether to receive critical agent alert notifications. daily_brief: Whether to receive daily brief availability notifications. quiet_hours_start: Hour (0-23) when quiet hours begin. quiet_hours_end: Hour (0-23) when quiet hours end. timezone: IANA timezone string for quiet hours calculation.

object
agent_alerts
required
boolean
approval_requests
required
boolean
daily_brief
required
boolean
quiet_hours_end
required
integer
quiet_hours_start
required
integer
timezone
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string