Update an alert rule - Send Alerts - API Reference

PUT

https://api.us.nylas.com/v3/alerts/send/{rule_id}

Updates the specified alert rule. Include only the fields you want to change. Changing a rule starts its alerts over, so a domain that's still past the new threshold gets a new alert.triggered notification.

NYLAS API KEY

Parameters

Path parameters

rule_id*string<uuid>

The ID of the alert rule.

Example: "8069c06e-a4c0-4bfa-9535-0f286575cc0e"

Request body

metricstring

The rate to watch. bounce_rate and complaint_rate fire when the rate goes above the threshold, and delivery_rate fires when it goes below.

bounce_ratecomplaint_ratedelivery_rate

Example: "bounce_rate"

thresholdnumber

The threshold, as a percentage with up to 2 decimal places. For bounce_rate and complaint_rate, at least 0 and less than 100. For delivery_rate, more than 0 and at most 100. The rule fires only when the rate is past the threshold, not equal to it.

Example: 5

window_hoursinteger

How many hours of sending the rate covers, from 1 to 24.

Example: 1

min: 1max: 24

min_volumeinteger

The minimum number of messages a sending domain must send in the window before the rule can fire. Use it to avoid alerts on low volume, where one bounce is a high rate.

Default: 0

Example: 50

min: 0max: 1000000000

Responses

request_idstring

The request ID.

dataobject

A rule that sends an alert.triggered webhook when a sending domain's rate crosses a threshold.

curl --request PUT \ --url "https://api.us.nylas.com/v3/alerts/send/<RULE_ID>" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "threshold": 3 }'