---
title: "Update a room"
method: PATCH
path: "/rooms/{id}"
tags: ["Rooms"]
---

# Update a room

`PATCH /rooms/{id}`

## Request

- Base URL: `https://dataroom.corgi.com/api/v1`
- URL: `https://dataroom.corgi.com/api/v1/rooms/{id}`
- Auth: HTTP bearer

Sparse patch of a room's settings, branding, and lifecycle. `frozen` toggles read-only-but-visible (frozenAt); `pinned` toggles pinnedAt; `status: CLOSED` closes the room without trashing it (distinct from DELETE, which soft-deletes). Branding URLs must pass the asset-URL allowlist; the `*UrlClear` fields (any value) reset their URL to null. Empty-string color resets are MCP-only (`update_room`) — this REST endpoint treats an empty string as an omitted field. Scope: `datarooms:write`.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `description` string
  - `ndaRequired` boolean
  - `watermark` boolean
  - `status` 'DRAFT' | 'ACTIVE' | 'CLOSED'
  - `frozen` boolean: true → read-only-but-visible (frozenAt)
  - `pinned` boolean
  - `displayMode` 'list' | 'grid'
  - `allowQuestions` boolean
  - `indexEnabled` boolean
  - `allowBulkDownload` boolean
  - `aiEnabled` boolean
  - `introEnabled` boolean
  - `introBody` string
  - `notifyNewDocs` boolean
  - `notifyVisitorUpload` boolean
  - `notifyOnView` boolean
  - `notifyOnDownload` boolean
  - `notifyOnNdaSigned` boolean
  - `logoUrl` string
  - `bannerUrl` string
  - `coverUrl` string
  - `logoUrlClear` string: Present (any string) → clears logoUrl
  - `bannerUrlClear` string: Present (any string) → clears bannerUrl
  - `coverUrlClear` string: Present (any string) → clears coverUrl
  - `accentColor` string: #RRGGBB
  - `logoShape` 'square' | 'soft' | 'rounded' | 'circle'
  - `titleFont` 'default' | 'serif' | 'mono'
  - `subtitleFont` 'default' | 'serif' | 'mono'
  - `titleColor` string: #RRGGBB
  - `subtitleColor` string
  - `defaultPermGroups` 'inherit' | 'ask' | 'hidden'
  - `defaultPermLinks` 'inherit' | 'ask' | 'hidden'

## Response `200`

Updated

## Other responses

- `400`: Invalid asset URL / color
- `404`: Not found

---

[API](https://skmtc.dev/corgi/apis/dataroom-api.md) - [All operations](https://skmtc.dev/corgi/apis/dataroom-api/llms.txt) - [OpenAPI document](https://skmtc.dev/corgi/apis/dataroom-api/revisions/73f75ef04a00?raw)