thread_pin

Pin a thread so it sorts above unpinned threads in its forum. Use it for rules, FAQs, or announcements that should stay at the top of the list.

Request

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

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

Response

{
  "cmd": "thread_pin",
  "thread_id": "0b7d1c2e-4f3a-4e8b-9a61-5c2d7e9f1a34",
  "channel": "projects",
  "pinned": true
}

channel is the parent forum. The thread now has pinned: true and pinned_at (Unix seconds). Pinning an already pinned thread succeeds and updates pinned_at.

The same frame is broadcast to every other connection whose user can view the forum, without listener.

Permissions

You must be an administrator (the owner, a user with the admin role, or a role with administrator) or have a role with manage_threads. Thread creators can’t pin their own threads.

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 pin threads`	You are not an administrator and lack `manage_threads`.
`Unable to save thread`	The server could not write the change to storage.
Validation message	`thread_id` is missing or empty, for example `thread_id: Required`.

See also