PATCH/api/apps/fleet/{installation_id}/alerts

Update fleet overdue check-in alerts

Updates the overdue check-in alert settings for a fleet. Supply only the alert fields you want to change; omitted fields keep their current values. Set overdue_alert_email to null to send the digest to the account owner.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
installation_idstringrequired
The identifier of the fleet installation whose alert settings to update.

The overdue check-in alert fields to update. Fields left out keep their current values.

overdue_alert_emailstringoptional
The email address that receives the overdue alert digest. Set to null to send the digest to the account owner.
overdue_alert_enabledbooleanoptional
Whether to send an overdue check-in alert digest.
overdue_alert_threshold_minutesintegeroptional
The overdue threshold in minutes: 30, 60, or 240.
Allowed:3060240

4 status codes
200Returns the updated fleet data, including its alert settings and push status.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the installation belongs to another user.
422Returned when the alert threshold is not one of the offered values.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the installation belongs to another user. A 422 is returned when overdue_alert_threshold_minutes is not an offered threshold. The installation_id path parameter must identify a fleet installation, and the threshold must be 30, 60, or 240 minutes when provided.