API Delete Room

From IVS Wiki
Revision as of 15:34, 18 September 2026 by IVSWikiBlue (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This API call will delete an existing room.

Resource URL

http://valt.example.com/api/v3/admin/rooms/{roomid}/delete

Replace {roomid} with the actual id number of the room. Rooms 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 Room Not Found
JSON Response
data
message Deleted

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/admin/rooms/69/delete?access_token=exampletoken

Successful Response

{
"data":{
"message": "Deleted"
}
}

Failure Response

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