---
title: "Update a forum."
method: PUT
path: "/forums/{forum_id}"
tags: ["Forums"]
---

# Update a forum.

`PUT /forums/{forum_id}`

## Request

- Base URL: `https://h2ogpte.genai.h2o.ai/api/v1`
- URL: `https://h2ogpte.genai.h2o.ai/api/v1/forums/{forum_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/forums/:forum_id/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `forum_id` string, required

## Request body

- ForumUpdateRequest
  - `name` string
  - `description` string

## Response `200`

The updated forum.

- Forum
  - `id` string, uuid
  - `name` string
  - `description` string
  - `user_id` string, uuid
  - `username` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `is_owner` boolean
  - `user_access_mode` string
  - `post_count` integer
  - `assistant_count` integer

## Other responses

- `401`: Unauthorized - Invalid or missing API key
- `default`: Unexpected error

---

[API](https://skmtc.dev/h2o/apis/h2ogpte-rest-api.md) - [All operations](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/revisions/a82a117320f4?raw)
