Liveblocks icon

Liveblocks

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

Yjs → Send Binary Update

AI-generated

Summary

Send a binary Yjs update to a specified Liveblocks room, optionally targeting a subdocument within that room.

Inputs

  • Room ID (required) — The Liveblocks room identifier to which the binary update will be sent.
  • Subdocument GUID — An optional identifier for a subdocument within the room, allowing more granular update targeting.
  • Input Binary Field (required) — The name of the binary property on the input item that contains the Yjs binary update data to send as an application/octet-stream.
  • Include Request in Error — When enabled, any failed API calls will include detailed request information (URL, method, headers, body, response) in the error for debugging purposes.

Output shape

A single response object containing the result of sending the Yjs binary update, including status or any error data.

The operation consumes the specified binary data input and sends it as an octet-stream payload to the Liveblocks API. Errors can carry rich debug information if enabled. No pagination or batch responses are involved.

Links

Discussion