Update email recipient settings

Update the settings of the alarms report email recipient.
Note: PATCH calls update data partially. Any data not mentioned in the call, will be kept as is. However, in this call, if only reportIntervalSeconds is provided in the request body, it returns a 400 Bad Request error. Other combinations of parameters in the request body function as expected.

Request
Security:
bearerAuth
path Parameters
recipientId
required
string^[1-9]\d*$

The ID of the email recipient. Obtain this from GET /recipients/health.

Example: 25
Request Body schema: application/json
reportIntervalSeconds
number (Device alarm report interval)

The frequency of the device alarms report, in seconds. To receive a report email every hour, the value should be 3600.

Array of objects

The alarm definitions array.

Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

patch/recipients/alarms/{recipientId}
Request samples
application/json
{
  • "reportIntervalSeconds": 3600,
  • "alarmDefinitions": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}