100ms Logo

100ms

Docs

Search docs
/

Disable/Enable a room

Trigger this request to disable a specific room.

Note: If you disable a room, that room can be used for only the current session and users will not be able to join the room later. You can use this API with the enabled param set to true to enable the room again.

POSThttps://api.100ms.live/v2/rooms/<room_id>
curl --location --request POST 'https://api.100ms.live/v2/rooms/<room_id>' \ --header 'Authorization: Bearer <management_token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "enabled": false }'
RESPONSE
Status: 200 OK
{ "id": "6316d5cfae8c4271df5d0554", "name": "new-room-1662440912", "enabled": false, "description": "", "customer_id": "627cdddff2e4e30487862ad1", "recording_source_template": true, "enabled_source_template": true, "recording": null, "template_id": "", "template": "", "region": "", "created_at": "2022-09-06T05:08:31.935Z", "updated_at": "2022-09-08T14:58:25.629819038Z" }

Arguments

NameTypeDescriptionRequired
room_id
— path param
stringUnique identifier of the room you wish to disable.

Example: 627cda81ab4f3b56a077dc33
Yes
enabled
— body param
booleanStatus of the room to be set.
Allowed values: true, false.
Should be set to false to disable the room
Yes

Have a suggestion? Recommend changes ->

Run in postman

Was this helpful?

1234