Liveblocks icon

Liveblocks

Call the Liveblocks REST API (rooms, comments, feeds, Yjs, AI, and more)

Room → Update Room ID

AI-generated

Summary

Change the identifier of an existing Liveblocks room by specifying its current Room ID and the new Room ID to assign.

Inputs

  • Room ID (required) — The current identifier of the Liveblocks room to update.
  • New Room ID (required) — The new identifier to assign to the room.
  • Include Request in Error — When enabled, includes request details in error messages for debugging.

Output shape

a single JSON object representing the result of the update operation

The operation outputs the API response containing updated room information or error details. Enabling 'Include Request in Error' will provide additional debugging data in case of failure.

Examples

Example 1: Rename a room from 'room123' to 'newRoom456'

Set 'Room ID' to 'room123' and 'New Room ID' to 'newRoom456'. Optionally enable 'Include Request in Error' for troubleshooting.

Links

Discussion