Liveblocks icon

Liveblocks

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

Room → Set Presence

AI-generated

Summary

Set a user's presence state in a specified Liveblocks room by providing user ID, presence data, user metadata, and optional presence TTL.

Inputs

  • Room ID (required) — Identifier of the Liveblocks room where presence is set.
  • User ID (required) — Identifier of the user whose presence is being set.
  • Presence Data (required) — Arbitrary JSON object representing the user's presence state.
  • User Info (required) — JSON object with metadata about the user or agent such as name, avatar, and color; use empty object if not applicable.
  • TTL (seconds) — Optional time-to-live in seconds for the presence, between 2 and 3599; omit or set to 0 to skip.

Output shape

a single record indicating success or failure of the presence update call

No pagination. Errors may optionally include request details if enabled in node parameter 'Include Request in Error'.

Links

Discussion