Skip to main content
PUT
/
v2
/
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.