UpdateForumRequest

A request or response body; the type column links to the schemas it refers to.

Field	Type	Required	Description
name	string	no	Unique within the department, ignoring case. 1–120 characters
description	string \| null	no	Send null or empty to clear the description. at most 1000 characters
archived	boolean	no	True archives the forum — its discussions stay readable, but nobody posts, replies or edits; false restores it.

Field

Type

Required

Description

name

string

Unique within the department, ignoring case.

1–120 characters

description

string | null

Send null or empty to clear the description.

at most 1000 characters

archived

boolean

True archives the forum — its discussions stay readable, but nobody posts, replies or edits; false restores it.

jsonExample

{
  "name": "Equipment questions",
  "description": "Ask about the bench tools, the hoods and the gauges.",
  "archived": true
}