---
title: "Rename document identifier"
method: PUT
path: "/api/v2/documents/{identifier}/identifier"
tags: ["Documents"]
---

# Rename document identifier

`PUT /api/v2/documents/{identifier}/identifier`

Rename a published document's identifier. The change is applied live and immediately — it does not go through the draft/publish workflow — and the former identifier is recorded in the document's rename history.

Only published documents can be renamed. A draft target returns 409; an unknown or archived target returns 404. The new identifier must be a valid slug (otherwise 400) and unused by any other document in the organization (otherwise 409).

## Path parameters

- `identifier` string, required — Document identifier — either the URL slug (e.g. `abc123`) or the canonical workbook UUID.

## Request body

- DocumentsV2UpdateIdentifierBody
  - `identifier` string, required — New identifier for the document. Must be unique within the organization.

## Response `200`

Identifier updated successfully.

- DocumentsV2UpdateIdentifierResponse
  - `description` string, nullable, required — Document description.
  - `identifier` string, required — The document identifier after the rename.
  - `name` string, required — Document name.

## Other responses

- `400` — Invalid identifier format.
- `401` — Authentication required.
- `403` — Insufficient permissions to rename the document.
- `404` — Document not found or archived.
- `405` — Method not allowed.
- `409` — The target is a draft rather than a published document, or the requested identifier is already in use by another document.

---

[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/4701f292c621/schema)