---
title: "Update a document"
method: PATCH
path: "/documents/{id}"
tags: ["Documents"]
---

# Update a document

`PATCH /documents/{id}`

## Request

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

Rename, move to a folder (`folderId`; `"root"` or empty for the top level), change status, star, or edit the description. Scope: `documents:write`.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `description` string
  - `starred` boolean
  - `status` 'DRAFT' | 'PUBLISHED' | 'ARCHIVED'
  - `folderId` string: Destination folder id, or "root"/empty for the top level

## Response `200`

Updated

## Other responses

- `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)