Room Identifier

Type: string
Required: Yes Format: UUID or any unique string identifier

Description

A unique identifier for a room. roomId is used across frontend and all API operations to create, retrieve, update, or delete a room. It must remain consistent throughout the room’s lifecycle and serves as the primary reference point for room-related actions and analytics.

Usage Recommendations

• roomId can be:

  • a UUID,
  • or aligned with the ID of a content item, event, or page on your platform.

  This helps maintain consistency between the social layer (e.g. chat) and the content being discussed. It also simplifies analytics, since all user-generated events include the roomId as a property.

• If you want to aggregate users from multiple entry points into a single shared space, simply reuse the sameroomId across different pages or sections. This is ideal for use cases like:

  • centralized support rooms,
  • event hubs,
  • global community chatrooms.

• If you’re creating rooms dynamically (e.g. one room per article, product, or video), we recommend using the internal ID of that content item as the roomId to maintain traceability and coherence in data.

• When passing roomId in URLs (e.g. GET /rooms/{roomId}), make sure it is properly URL-encoded if it includes special characters.

Examples

"roomId": "d51f9c82-a127-11ee-a1eb-0242ac120002"

"roomId": "tournament-final-2025"

"roomId": "room-abc123xyz"