Update Deliverability Alert
Updates a deliverability alert’s threshold, evaluation window, notification channels, scope filter, or enabled state.
widget, metric, severity, and scope are immutable. To change one of them, delete this alert and create a new one.Common updates
- Pause/resume an alert by sending
{"enabled": false}or{"enabled": true}. - Tune sensitivity by adjusting
threshold,periodDays, orperiodMode. - Add a channel by sending the full
channelConfigwith the new channel set toenabled: true. Channels you omit are left untouched. - Restrict the scope by sending
scopeEntities(only meaningful whenscopeismailboxordomain).
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Unique alert configuration ID.
Body
All fields are optional. Only the supplied fields are updated. widget, metric, severity, and scope cannot be changed after creation — create a new alert if you need different dimensions.
0 <= x <= 100equal, below, above 1 <= x <= 30rolling, consecutive Same format as on creation. Only meaningful when the alert's scope is mailbox or domain.
Pause or resume evaluation of this alert.
Response
Alert updated
A deliverability alert configuration. The alert is evaluated periodically against your warm-up or outreach metrics and triggers notifications through the configured channels (in-app, email, webhook, Slack) when the threshold is breached.
Unique alert configuration identifier (prefixed with dac_).
ID of the team that owns the alert.
ID of the user who created the alert.
Creation timestamp.
Last update timestamp.
Data source the alert evaluates. warmup checks lemwarm metrics; outreach checks campaign-sending metrics.
warmup, outreach Metric being monitored. Valid combinations depend on widget: warmup supports inboxRate, spamRate, score; outreach supports deliveryRate, bounceRate.
inboxRate, spamRate, score, deliveryRate, bounceRate Alert severity.
warning, critical Aggregation level the metric is computed at. global covers all of the workspace's mailboxes (warm-up only); mailbox evaluates each mailbox individually; domain groups mailboxes by their sending domain.
global, mailbox, domain Restricts the alert to a subset of entities matching scope. When empty, all entities of that scope are checked. For scope=mailbox, each entry is a composite string userId|email|mailboxId. For scope=domain, each entry is a domain (e.g. acme.com). Ignored when scope=global.
Threshold value the metric is compared against (0–100, expressed as a percentage for rate metrics).
0 <= x <= 100How threshold is compared to the current value. below triggers when the value drops under the threshold; above triggers when it exceeds it; equal triggers on exact match.
equal, below, above Length of the evaluation window, in days (1–30).
1 <= x <= 30How the metric is computed over periodDays. rolling averages the metric across the window; consecutive requires the condition to hold on every one of the most recent periodDays.
rolling, consecutive Notification channels triggered when the alert fires. At least one channel must be enabled. If omitted on creation, defaults to inapp only.
Whether the alert is currently active. Disabled alerts are not evaluated.
Last time the alert was evaluated.
Last time the alert fired.
Cool-down between re-evaluations after the alert has triggered, in hours. Defaults to 12.