Difference between revisions of "API Delete Schedule"

From IVS Wiki
Jump to: navigation, search
(Created page with "This API call will delete an existing schedule. ===Resource URL=== <pre>http://valt.example.com/api/v3/schedule/{scheduleid}/delete</pre> ''Replace {scheduleid} with the actu...")
 
 
Line 41: Line 41:
 
==Examples==
 
==Examples==
 
===Request===
 
===Request===
<pre>https://ivstest1.ad.ipivs.com/api/v3/schedule/4/delete?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
+
<pre>https://ivstest1.ad.ipivs.com/api/v3/schedule/4/delete?access_token=exampletoken</pre>
  
 
===Successful Response===
 
===Successful Response===

Latest revision as of 15:41, 18 September 2026

This API call will delete an existing schedule.

Resource URL

http://valt.example.com/api/v3/schedule/{scheduleid}/delete

Replace {scheduleid} with the actual id number of the schedule. Schedules are numbered sequentially when added to VALT.

Resource Information

Method POST
Response Type JSON
Authentication Required Yes

Parameters

No parameters are required for this API call.

Response

Code Reason
200 Request Successful
401 Unauthorized
404 Schedule Not Found

Upon success the call returns an empty result set.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/schedule/4/delete?access_token=exampletoken

Successful Response

{
}

Failure Response

{
"error":{
"code": 404
}
}