Skip to main content
POST
/
v1
/
documents
/
{documentId}
/
duplicate
Duplicate published document
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/duplicate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Dashboard Copy",
  "folderPath": "/reports/2024/q4",
  "scope": "organization"
}
'
{
  "dashboardId": "abc123-dash-id",
  "identifier": "xyz789-new-identifier",
  "name": "My Dashboard Copy",
  "workbookId": "def456-workbook-id"
}
Only published documents can be duplicated. Attempting to duplicate a draft document will return a 404 error.
Duplicate a published document.

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

​
documentId
string
required

Document identifier

Query Parameters

​
userId
string

Requires an Organization API key. Optional user ID that attributes the action to the specified user.

Body

application/json
​
name
string
required

The name for the duplicated document

Required string length: 1 - 255
​
folderPath
string | null

Path to the destination folder. If not provided, the document will be duplicated to the root.

​
scope
enum<string>

The visibility scope for the duplicated document.

If not provided, inherits from the destination folder or defaults to restricted.

Available options:
organization,
restricted

Response

Document duplicated successfully

​
dashboardId
string

The dashboard ID, if the duplicated document has a dashboard

​
identifier
string

Unique identifier for the newly created document

​
name
string

The name of the duplicated document

​
workbookId
string

The workbook ID of the duplicated document