thread_join

Join a thread, adding yourself to its participants. Use it for a “follow” or “join” button on a thread.

Joining doesn’t change what you can read or post; that comes from the parent forum’s permissions. It affects which threads appear in your recent-thread list from channels_get. See threads and forums.

Request

{
  "cmd": "thread_join",
  "thread_id": "0b7d1c2e-4f3a-4e8b-9a61-5c2d7e9f1a34"
}

Field	Type	Required	Description
`thread_id`	string	Yes	ID of the thread to join.

Response

{
  "cmd": "thread_join",
  "thread_id": "0b7d1c2e-4f3a-4e8b-9a61-5c2d7e9f1a34",
  "channel": "projects",
  "user": "bob",
  "thread": {
    "id": "0b7d1c2e-4f3a-4e8b-9a61-5c2d7e9f1a34",
    "name": "My first project",
    "parent_channel": "projects",
    "created_by": "alice",
    "created_at": 1788624000,
    "locked": false,
    "archived": false,
    "participants": ["alice", "bob"],
    "message_count": 14,
    "last_message": 1788631200,
    "last_message_id": "8f14e45f-ceea-467a-9575-3d3b4c1b2a10"
  }
}

user is the username of the user who joined.
thread is the updated thread object.
channel is the parent forum.

Joining a thread you are already in succeeds and doesn’t add you twice. The same frame is broadcast to every other connection whose user can view the forum, without listener.

Permissions

You need to be able to view the parent forum, and the thread must not be locked.

The command is blocked while you are timed out.

Errors

`val`	When
`Thread not found`	No thread has this ID.
`You do not have permission to view this thread`	You can’t view the parent forum.
`This thread is locked`	The thread is locked.
Validation message	`thread_id` is missing or empty, for example `thread_id: Required`.

See also