Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Documents v2

Rename document identifier

Rename a published document's identifier. The change is applied live and immediately. Changes do not go through the draft/publish workflow. The former identifier is recorded in the document's rename history to enable automatic redirects. Only published documents can be renamed.

The new identifier must be a valid slug and unused by any other document in the organization. If the new value is identical to the existing value (case-sensitive), the API will return a 200 but not write a history record.

put/v2/documents/{documentId}/identifier

Path parameters

identifierstring required

Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.

Request body

identifierstring required

Document identifier slug. Must be 2–48 characters, containing only lowercase letters (a-z), digits (0-9), hyphens (-), and underscores (_). Cannot be a reserved value. If omitted when creating a document, an identifier is auto-generated.

Example request

{
  "identifier": "q2-revenue"
}

Response

Identifier renamed successfully.

identifierstring required

The document identifier after the rename.

namestring required

Document name.

descriptionstring nullable required

Document description.

Example response

{
  "identifier": "new-slug",
  "name": "Q2 Revenue Analysis"
}