Nylas has updated its pricing model.See current pricing on nylas.com →

Command

nylas deliverability send-alerts update

Change a send alert rule; flags you leave out keep their value.

Written by Qasim Muhammad Staff SRE

What does nylas deliverability send-alerts update do?

The nylas deliverability send-alerts update command changes a send alert rule. Only the flags you set are sent, and the rest of the rule keeps its value. It covers only messages sent from an Agent Account or through Transactional send; messages from connected grants such as Google or Microsoft accounts are not included. Use it to tune a threshold or window without recreating the rule.

Usage

nylas deliverability send-alerts update <rule-id> [--metric METRIC] [--threshold PERCENT] [--window-hours HOURS] [--min-volume N] [--json]

Flags

FlagDescription
--jsonOutput as JSON
--no-colorDisable color output
--verbose(-v)Enable verbose output
--configCustom config file path
--help(-h)Show help for the command
--limitLimit results (most list commands)
--yes(-y)Skip confirmations
--metricMetric: bounce_rate, complaint_rate, delivery_rate (unchanged if not set)
--min-volumeMinimum sends in the window before the rule can fire (unchanged if not set)
--thresholdThreshold percent, up to 2 decimals; bounce/complaint fire above it (0 to <100), delivery fires below it (>0 to 100) (unchanged if not set)
--window-hoursLook-back window in hours, 1-24 (unchanged if not set)

Examples

The nylas deliverability send-alerts update command changes a send alert rule.

Lower a threshold

nylas deliverability send-alerts update 3d6f8a1c-2b4e-4c7d-9f0a-1b2c3d4e5f60 --threshold 3

Troubleshooting

nothing to update

Set at least one of --metric, --threshold, --window-hours, or --min-volume.

alert rule not found

Rule IDs are lowercase UUIDs from nylas deliverability send-alerts list. A rule from another application is also reported as not found.

Recommended guides

Run nylas deliverability send-alerts update --help for full help output.