Comments

Subscribe to thread

Changed on

This endpoint subscribes to a thread. Corresponds to liveblocks.subscribeToThread.

post/rooms/{roomId}/threads/{threadId}/subscribe

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/rooms/{roomId}/threads/{threadId}/subscribe
  • Auth: none declared

Path parameters

roomIdstring required

ID of the room

Example:my-room-id
threadIdstring required

ID of the thread

Example:th_abc123

Request body

userIdstring required

Example request

{
  "userId": "alice"
}

Response

Success. Returns the thread subscription.

kindstring required
subjectIdstring required
createdAtstring date-time required

Example response

{
  "kind": "thread",
  "subjectId": "th_abc123",
  "createdAt": "2022-07-13T14:32:50.697Z"
}

Changes

  • 77cd6a75b2b7Revision changes
    • info

      api operation id post-rooms-roomId-threads-threadId-subscribe removed and replaced with subscribe-to-thread

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 2c68c23ad602Revision changes
    • breaking

      added required request body