COcorgi
Rooms

Update a room

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.

patch/rooms/{id}

Request

  • Base URL
    https://dataroom.corgi.com/api/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

namestring
descriptionstring
ndaRequiredboolean
watermarkboolean
status'DRAFT' | 'ACTIVE' | 'CLOSED'
frozenboolean

true → read-only-but-visible (frozenAt)

pinnedboolean
displayMode'list' | 'grid'
allowQuestionsboolean
indexEnabledboolean
allowBulkDownloadboolean
aiEnabledboolean
introEnabledboolean
introBodystring
notifyNewDocsboolean
notifyVisitorUploadboolean
notifyOnViewboolean
notifyOnDownloadboolean
notifyOnNdaSignedboolean
logoUrlstring
bannerUrlstring
coverUrlstring
logoUrlClearstring

Present (any string) → clears logoUrl

bannerUrlClearstring

Present (any string) → clears bannerUrl

coverUrlClearstring

Present (any string) → clears coverUrl

accentColorstring

#RRGGBB

logoShape'square' | 'soft' | 'rounded' | 'circle'
titleFont'default' | 'serif' | 'mono'
subtitleFont'default' | 'serif' | 'mono'
titleColorstring

#RRGGBB

subtitleColorstring
defaultPermGroups'inherit' | 'ask' | 'hidden'
defaultPermLinks'inherit' | 'ask' | 'hidden'

Response

Updated

Changes

No recorded changes to this operation across all 1 revision of this API.