PATCH apioauth/matrixv2/voltagealerts/{voltageAlertId}

Update a voltage alert

Request Information

URI Parameters

Name	Description	Type	Additional information
voltageAlertId	The id of the voltage alert to be updated	unsigned integer	Required

Body Parameters

A patch request

PatchVoltageAlertRequest

Name	Description	Type	Additional information
Title	The alert title	string	None.
Message	The alert message	string	None.
VoltageThreshold	The value the alert will be triggered on - set to null if value will not be changed	decimal number	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:

{
  "Title": "sample string 1",
  "Message": "sample string 2",
  "VoltageThreshold": 1.1,
  "PushNotificationEnabled": true,
  "InboxMessageEnabled": true,
  "EmailEnabled": true
}

application/xml, text/xml

Sample:

<PatchVoltageAlertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Title>sample string 1</Title>
  <Message>sample string 2</Message>
  <VoltageThreshold>1.1</VoltageThreshold>
  <PushNotificationEnabled>true</PushNotificationEnabled>
  <InboxMessageEnabled>true</InboxMessageEnabled>
  <EmailEnabled>true</EmailEnabled>
</PatchVoltageAlertRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 on success

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.