Skip to content

Update Notification Preferences

PUT
/api/v1/notifications/preferences
curl --request PUT \
--url https://api.ultimateteam.ai/api/v1/notifications/preferences \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "agent_alerts": true, "approval_requests": true, "daily_brief": true, "proactive_insights": true, "quiet_hours_end": 1, "quiet_hours_start": 1, "timezone": "example" }'

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.

Media typeapplication/json
UpdateNotificationPreferencesRequest

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
proactive_insights
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
Examplegenerated
{
"agent_alerts": true,
"approval_requests": true,
"daily_brief": true,
"proactive_insights": true,
"quiet_hours_end": 1,
"quiet_hours_start": 1,
"timezone": "example"
}

Successful Response

Media typeapplication/json
NotificationPreferencesResponse

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
Agent Alerts
boolean
approval_requests
required
Approval Requests
boolean
daily_brief
required
Daily Brief
boolean
proactive_insights
required
Proactive Insights
boolean
quiet_hours_end
required
Quiet Hours End
integer
quiet_hours_start
required
Quiet Hours Start
integer
timezone
required
Timezone
string
Examplegenerated
{
"agent_alerts": true,
"approval_requests": true,
"daily_brief": true,
"proactive_insights": true,
"quiet_hours_end": 1,
"quiet_hours_start": 1,
"timezone": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}