Add health report email recipient

Add an email address to which health reports are sent. Emails are sent at a set interval.

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
required
string <email> (Email) ^\S+@\S+\.\S{2,}$

The email address of the entity.

reportIntervalSeconds
required
number (Device health report interval)

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

organizationId
number (Organization ID)

The ID of the organization. Obtain this from GET /organizations.

Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

post/recipients/health
Request samples
application/json
{
  • "email": "email@email.com",
  • "reportIntervalSeconds": 3600,
  • "organizationId": 17
}
Response samples
application/json
{
  • "data": {
    }
}