v4
latestOpenAPI 3.1.02026-08-01207318738.7 KBDocuments
Rename document 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).
put/api/v2/documents/{identifier}/identifier
Path parameters
identifierstring required
Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.
Example:abc123
Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.
Request body
Example request
{
"identifier": "new-slug"
}Response
Identifier updated successfully.