---
title: "PATCH /api/v1/documents/{DocumentId}"
method: PATCH
path: "/api/v1/documents/{DocumentId}"
---

# PATCH /api/v1/documents/{DocumentId}

`PATCH /api/v1/documents/{DocumentId}`

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

## Path parameters

- `DocumentId` string, required

## Headers

- `Authentication` string, password

## Request body

- object
  - `Name` string, password — The name of the document.
  - `ParentFolderId` string — The ID of the parent folder.
  - `ResourceState` 'ACTIVE' | 'RESTORING' | 'RECYCLING' | 'RECYCLED' — The resource state of the document. Only ACTIVE and RECYCLED are supported.

## Response `200`

Success

## Other responses

- `480` — EntityNotExistsException
- `481` — EntityAlreadyExistsException
- `482` — LimitExceededException
- `483` — ProhibitedStateException
- `484` — ConflictingOperationException
- `485` — ConcurrentModificationException
- `486` — UnauthorizedOperationException
- `487` — UnauthorizedResourceAccessException
- `488` — FailedDependencyException
- `489` — ServiceUnavailableException

---

[API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)