bullpen notifications preferences update¶
Last updated: July 13, 2026
Update notification preferences
Usage¶
Live Help¶
Update notification preferences
Usage: bullpen notifications preferences update [OPTIONS]
Options:
--global <on|off>
Toggle all notification delivery
[possible values: on, off]
--output <OUTPUT>
Output format for command results
[possible values: table, json]
--env <ENV>
Target environment to connect to (overrides config.toml)
[env: BULLPEN_ENV=]
[possible values: staging, production]
--telegram <on|off>
Toggle Telegram notifications
[possible values: on, off]
--config <CONFIG>
Path to a custom config.toml file (overrides $BULLPEN_CONFIG and the default location).
Explicit --config and BULLPEN_CONFIG paths fail closed: if the file is missing, the CLI exits validation instead of silently loading defaults. Credentials still resolve via BULLPEN_HOME, so set BULLPEN_HOME too when isolating a session.
--inapp <on|off>
Toggle in-app notifications
[possible values: on, off]
--push <on|off>
Toggle push notifications
[possible values: on, off]
--quiet-hours-start <QUIET_HOURS_START>
Quiet-hours start hour, 0-23
--quiet-hours-end <QUIET_HOURS_END>
Quiet-hours end hour, 0-23
--quiet-timezone <QUIET_TIMEZONE>
Quiet-hours timezone, e.g. America/New_York
--read-only
Enable read-only mode: blocks all mutating commands
--non-interactive
Suppress interactive prompts; does NOT imply --yes for money-moving commands
[env: BULLPEN_NON_INTERACTIVE=]
-h, --help
Print help (see a summary with '-h')
EXAMPLES:
# Review current notification preferences before changing them
bullpen notifications preferences get
# Disable Telegram and keep in-app notifications enabled; this changes preferences
bullpen notifications preferences update --telegram off --inapp on
# Configure quiet hours with an explicit timezone; this changes preferences
bullpen notifications preferences update --quiet-hours-start 22 --quiet-hours-end 7 --quiet-timezone America/New_York
# Export updated preferences as JSON
bullpen notifications preferences update --telegram off --inapp on --output json
Example Commands¶
JSON Output¶
Contract: JSON Output Contract.
Successful output is a single JSON document. The shape below is representative for this command family; commands may add fields without breaking the shared contract.
Schema version: 1 when a command emits schema_version; otherwise treat the current command shape as contract version 1.
Top-level Keys¶
| key | type | nullable | notes |
|---|---|---|---|
status |
string | no | updated after preferences are saved |
preferences |
object | no | Updated notification preferences returned by the server |
preferences.global_enabled |
boolean | no | Whether all notification delivery is enabled |
preferences.telegram_enabled |
boolean | no | Whether Telegram notifications are enabled |
preferences.inapp_enabled |
boolean | no | Whether in-app notifications are enabled |
preferences.push_enabled |
boolean | no | Whether push notifications are enabled |
preferences.quiet_hours_start |
integer | yes | Quiet-hours start hour when configured |
preferences.quiet_hours_end |
integer | yes | Quiet-hours end hour when configured |
preferences.quiet_timezone |
string | yes | Quiet-hours timezone when configured |
Example¶
{
"status": "updated",
"preferences": {
"global_enabled": true,
"telegram_enabled": false,
"inapp_enabled": true,
"push_enabled": true,
"quiet_hours_start": 22,
"quiet_hours_end": 7,
"quiet_timezone": "America/New_York"
}
}
Stability¶
Patch releases may add nullable or optional fields. Minor releases may add required fields or increment schema_version. Major releases may remove or rename fields.