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
AlertTriggers Enum:
CallSpend
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
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 .csv suffix or ?format=csv

HTTP + CSV

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: evovoice.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"alertId":"String","name":"String","trigger":"CallSpend","windowHours":0,"threshold":0,"notificationEmailAddresses":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"accountId":"String","name":"String","trigger":"CallSpend","windowHours":0,"threshold":0,"notificationEmailAddresses":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}