OMomniapp
Documents

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, 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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v2/documents/{identifier}/identifier
  • Auth
    HTTP bearer

Path parameters

identifierstring required

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

Example:abc123

Request body

identifierstring required

New identifier for the document. Must be unique within the organization.

Example request

{
  "identifier": "new-slug"
}

Response

Identifier updated successfully.

descriptionstring nullable required

Document description.

identifierstring required

The document identifier after the rename.

namestring required

Document name.

Changes

No recorded changes to this operation across all 97 revisions of this API.