---
title: "Rename document"
method: PATCH
path: "/api/v1/documents/{identifier}"
tags: ["Documents"]
deprecated: true
---

# Rename document

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

> **Deprecated.**

**Deprecated** — use `PATCH /api/v2/documents/{identifier}/draft` (and the related `/draft` routes). Removed on July 31, 2026: this endpoint now returns `410` unless your organization has been granted a migration extension. Contact support if you need one.

Updates a document's name, description, and/or identifier. This is a partial update — only provided fields are modified, and at least one of `name`, `description`, or `identifier` must be supplied. When `identifier` is changed, the previous identifier is retained in the document identifier history and continues to redirect. For published documents, the update goes through a draft/publish workflow automatically.

## Path parameters

- `identifier` string, required — Document identifier (either document ID or identifier slug)

## Request body

- DocumentsUpdateBody
  - `clearExistingDraft` boolean — Clear existing draft before updating (for published documents with drafts)
  - `description` string, nullable — Document description
  - `identifier` string — New identifier for the document. Must be unique within the organization. The previous identifier is retained in the document identifier history and continues to redirect.
  - `name` string — New document name

## Response `200`

Document updated successfully

- DocumentsUpdateResponse
  - `description` string, nullable — Document description
  - `identifier` string, required — Document identifier
  - `name` string, required — Updated document name

## Other responses

- `400` — Invalid request body or validation error (e.g. missing name/description/identifier, name too long, identifier already in use)
- `401` — Authentication required
- `403` — Permission denied - EDITOR role required
- `404` — Document not found
- `409` — Draft already exists - set clearExistingDraft to true to discard it and proceed
- `410` — Endpoint has been removed; the organization does not hold a migration extension

---

[API](https://skmtc.net/omniapp/apis/omni-api.md) · [All operations](https://skmtc.net/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omniapp/omni-api/versions/de7cac8b5983/schema)