PATCH api/SocialDriver/TelemetryAlert?alertId={alertId}

Update a Telemetry alert

Request Information

URI Parameters

NameDescriptionTypeAdditional information
alertId

The id of the alert to be patched

unsigned integer

Required

Body Parameters

A PatchTelemetryAlertRequest

PatchTelemetryAlertRequest
NameDescriptionTypeAdditional information
ServiceId

The service id to monitor the alert on

unsigned integer

None.

AlertType

The type of alert to setup

AlertNotificationTypeEnum

None.

PushNotificationEnabled

If you want mobile push notifications sent on alert

boolean

None.

InboxMessageEnabled

If you want an inbox message sent on alert

boolean

None.

EmailEnabled

If you want emails sent on alert

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceId": 1,
  "AlertType": 0,
  "PushNotificationEnabled": true,
  "InboxMessageEnabled": true,
  "EmailEnabled": true
}

application/xml, text/xml

Sample:
<PatchTelemetryAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceId>1</ServiceId>
  <AlertType>Heartbeat_Voltage</AlertType>
  <PushNotificationEnabled>true</PushNotificationEnabled>
  <InboxMessageEnabled>true</InboxMessageEnabled>
  <EmailEnabled>true</EmailEnabled>
</PatchTelemetryAlertRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A 200 on success

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.