Scheduler APIs
-
Update Scheduled Alert
Description: Updates an existing alert scheduleUsage:
PUT api/Alerts/Schedules/Update
Parameter Type Source Description AlertProfile ScheduledAlert FromBody ScheduledAlert object to update Returns:
0 on success
Examples:
<!-- Intent: updates the existing scheduled alert with schedulecode of 597737 PUT to the following url http://api.v4.swiftreach.com/api/Alerts/Schedules/Update --> <!-- XML Input --> <ScheduledAlert xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema/API.V4.DataWrappers" xsi:type="Schedule_Run_Once"> <ScheduleCode>597737</ScheduleCode> <IsActive>true</IsActive> <ScheduleType>run_once</ScheduleType> <TaskDateTime>4/2/2015 12:00 PM</TaskDateTime> <TaskName>My Scheduled Alert 2</TaskName> <Description>Example of a scheduled alert that will run on a specific date and time</Description> <ContactLists> <int>668447</int> </ContactLists> <VoiceCode>0</VoiceCode> <FaxCode>0</FaxCode> <EmailCode>0</EmailCode> <SMSCode>660197</SMSCode> <PagerCode>0</PagerCode> <HotlinePhone/> <HotlineSettings xsi:nil="true" /> </ScheduledAlert> <!-- example return value --> <int>0</int>