Evo Voice

<back to all web services

PatchAlert

Update a specific alert

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
PATCH/alerts/{alertId}
PatchAlert Parameters:
NameParameterData TypeRequiredDescription
AlertIdpathstringNoThe ID of the alert you want to update
NamequerystringNoThe name for the alert
TriggerqueryAlertTriggers?NoThe trigger alert
WindowHoursquerydouble?NoThe number of hours for the window over which the alert will trigger
Thresholdquerydouble?NoThe value at which the alert will trigger
NotificationEmailAddressesquerystringNoThe email addresses (one per line) to notify
CustomerSelectionqueryAlertCustomerSelection?NoCustomer selection for this alert
CustomerIdsqueryList<string>NoThe list of customer IDs for the selection model
AlertTriggers Enum:
CallSpend
CallCount
AlertCustomerSelection Enum:
AllCustomers
ExcludeCustomers
IncludeCustomers
AlertInfo Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe ID of the account associated with this alert
NameformstringNoThe name of the alert
TriggerformAlertTriggersNoThe trigger alert
WindowHoursformdoubleNoThe number of hours for the window over which the alert will trigger
ThresholdformdoubleNoThe value at which the alert will trigger
NotificationEmailAddressesformstringNoThe email addresses (one per line) to notify
CustomerSelectionformAlertCustomerSelectionNoCustomer selection for this alert
CustomerIdsformList<string>NoThe list of customer IDs for the selection model
EntityInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of the object
DateCreatedformstringNoThe date the object was created
DateLastModifiedformstringNoThe date the object was last modified
CreatedByformstringNoThe user that created this object
LastModifiedByformstringNoThe user that last modified this object

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /alerts/{alertId} HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchAlert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Alerts">
  <AlertId>String</AlertId>
  <CustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CustomerIds>
  <CustomerSelection>AllCustomers</CustomerSelection>
  <Name>String</Name>
  <NotificationEmailAddresses>String</NotificationEmailAddresses>
  <Threshold>0</Threshold>
  <Trigger>CallSpend</Trigger>
  <WindowHours>0</WindowHours>
</PatchAlert>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AlertInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Alerts">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AccountId>String</AccountId>
  <CustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CustomerIds>
  <CustomerSelection>AllCustomers</CustomerSelection>
  <Name>String</Name>
  <NotificationEmailAddresses>String</NotificationEmailAddresses>
  <Threshold>0</Threshold>
  <Trigger>CallSpend</Trigger>
  <WindowHours>0</WindowHours>
</AlertInfo>