Liveblocks icon

Liveblocks

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

Room → Delete

AI-generated

Summary

Delete a specific Liveblocks room identified by its Room ID.

Inputs

  • Room ID (required) — The unique identifier of the Liveblocks room to delete.
  • Include Request in Error — Optionally include detailed request information in error messages for failed API calls to aid debugging.

Output shape

a single JSON object containing the API response to the delete operation, typically confirming deletion or returning metadata relevant to success or failure.

Errors returned by the API can include detailed request data if 'Include Request in Error' is enabled, otherwise only standard error information is returned.

Examples

Example 1: Remove a room by specifying its Room ID to permanently delete it from Liveblocks.

Set the 'Room ID' input to the target room's identifier, and optionally enable 'Include Request in Error' to get detailed debugging information if the call fails.

Links

Discussion