BEbetagouv
Rooms

Update a room

Changed on

Partially updates a room. Only the delegated user's rooms where they are administrator or owner can be updated; any other role gets a 403.

Updatable fields: access_level and configuration. Every other field (id, name, slug, pin_code) is read-only and silently ignored when sent.

configuration is replaced as a whole, it is not merged with the stored one. Send the complete object you want the room to end up with.

Full replacement (PUT) is not supported. Use PATCH instead.

patch/rooms/{id}

Request

  • Base URL
    https://visio-sandbox.beta.numerique.gouv.fr/external-api/v1.0
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Room UUID

Request body

access_level'public' | 'trusted' | 'restricted'

Controls who can join the room without going through the lobby.

  • public: Anyone with the room link can join directly, no authentication required.
  • trusted: Authenticated users join directly. Unauthenticated users wait in the lobby for approval.
  • restricted: Only participants explicitly trusted by the owner bypass the lobby. Everyone else waits for approval regardless of authentication.

public is rejected with a 400 unless the deployment explicitly enables it for this API. This applies both when creating a room and when updating one.

Example request

{
  "access_level": "trusted",
  "configuration": {
    "can_publish_sources": [
      "camera",
      "microphone"
    ],
    "everyone_can_mute": true
  }
}

Response

Room updated successfully

idstring uuid

Unique room identifier

slugstring

URL-friendly room identifier (auto-generated)

access_level'public' | 'trusted' | 'restricted'

Controls who can join the room without going through the lobby.

  • public: Anyone with the room link can join directly, no authentication required.
  • trusted: Authenticated users join directly. Unauthenticated users wait in the lobby for approval.
  • restricted: Only participants explicitly trusted by the owner bypass the lobby. Everyone else waits for approval regardless of authentication.

public is rejected with a 400 unless the deployment explicitly enables it for this API. This applies both when creating a room and when updating one.

urlstring uri

Full URL to access the room

Example response

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "slug": "aze-eere-zer",
  "access_level": "trusted",
  "url": "https://visio-sandbox.beta.numerique.gouv.fr/aze-eere-zer",
  "telephony": {
    "enabled": true,
    "pin_code": "123456",
    "phone_number": "+1-555-0100",
    "default_country": "US"
  },
  "configuration": {
    "can_publish_sources": [
      "camera",
      "microphone"
    ],
    "everyone_can_mute": true
  }
}

Changes