curl --request PUT \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/identifier \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "new-q2-revenue"
}
'

{
  "identifier": "new-q2-revenue",
  "name": "Q2 Revenue Analysis",
  "description": "Quarterly revenue review"
}

Management

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

documents

{documentId}

identifier

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId}/identifier \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "new-q2-revenue"
}
'

{
  "identifier": "new-q2-revenue",
  "name": "Q2 Revenue Analysis",
  "description": "Quarterly revenue review"
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

identifier

string

required

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

Body

application/json

identifier

string

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.

Required string length: 2 - 48

Pattern: ^[a-z0-9_-]+$

Example:

"q2-revenue"

Response

Identifier renamed successfully.

identifier

string

required

The document identifier after the rename.

Example:

"new-slug"

name

string

required

Document name.

Example:

"Q2 Revenue Analysis"

description

string | null

required

Document description.

List documents

Move document

⌘I

Getting started

AI APIs

API token APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Rename document identifier

Authorizations

Path Parameters

Body

Response