API Delete Filter

From IVS Wiki
Jump to: navigation, search

This API call will delete an existing room.

Resource URL

http://valt.example.com/api/v3/filters/{filterid}/delete

Replace {filterid} with the actual id number of the filter. Filters 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 Filter Not Found
JSON Response
data
message Removed

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/filters/6/delete?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

{
"data":{
"message": "Removed"
}
}

Failure Response

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