Update Notification Preferences

PUT /api/v1/preferences/notifications

Update notification preferences for the current user.

Operation ID: update_notification_preferences_api_v1_preferences_notifications_put · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: NotificationPreferencesUpdate

messages_email boolean
messages_in_app boolean
reports_email boolean
reports_in_app boolean
alerts_email boolean
alerts_in_app boolean
action_items_email boolean
action_items_in_app boolean
anomalies_email boolean
anomalies_in_app boolean

Responses

200 Successful Response

Schema: NotificationPreferencesResponse

messages_email boolean: Email for messages
messages_in_app boolean: In-app for messages
reports_email boolean: Email for reports
reports_in_app boolean: In-app for reports
alerts_email boolean: Email for alerts
alerts_in_app boolean: In-app for alerts
action_items_email boolean: Email for action items
action_items_in_app boolean: In-app for action items
anomalies_email boolean: Email for transaction anomalies
anomalies_in_app boolean: In-app for transaction anomalies

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

PUT /api/v1/preferences/notifications

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/preferences/notifications' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages_email": false,
  "messages_in_app": false,
  "reports_email": false,
  "reports_in_app": false,
  "alerts_email": false,
  "alerts_in_app": false
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/preferences/notifications', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "messages_email": false,
  "messages_in_app": false,
  "reports_email": false,
  "reports_in_app": false,
  "alerts_email": false,
  "alerts_in_app": false
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "messages_email": false,
  "messages_in_app": false,
  "reports_email": false,
  "reports_in_app": false,
  "alerts_email": false,
  "alerts_in_app": false
}

response = httpx.put("https://api.ondayzero.com/api/v1/preferences/notifications", headers=headers, json=payload)
data = response.json()