Add email recipient

Add an email address to which alarms reports are sent. Emails are sent at a set interval. Partners can add alarms recipient specific to an organization by providing the organization ID.

Note: POST calls create new data, and do not affect existing data.

Request
Security:
bearerAuth
query Parameters
organizationId
string (Organization ID as string) ^[1-9]\d*$

Filter by the ID of the partner’s organization. Obtain this from GET /organizations. This is an optional parameter for partners.

Example: organizationId=17
Request Body schema: application/json
email
string <email> (Email) ^\S+@\S+\.\S{2,}$

The email address of the entity.

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 definition array.

Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

post/recipients/alarms
Request samples
application/json
{
  • "email": "email@email.com",
  • "reportIntervalSeconds": 3600,
  • "alarmDefinitions": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}