Skip to main content
Create, manage, and configure documents, including permissions, drafts, labels, favorites, and app content.
omni documents update (rename) and omni documents put (full replace) no longer exist. The API endpoints behind them were removed, so the commands were dropped from the CLI in v1.2.2. Use the v2 commands below for renaming and editing content. omni documents transfer-ownership is still available but deprecated; grant the OWNER permission role with add-permits instead.

​
Document content (v2)

The v2 commands manage a document’s content (tiles, queries, dashboard layout) through an explicit draft/publish workflow. They replace the removed update and put commands.

​
App content (v2)

The app commands read and write the HTML and settings of a document’s app. A document holds an app or a dashboard, never both, and a workbook-only document holds neither.
The app commands are in alpha. These API routes can change shape without a deprecation cycle. The other document commands, and apps themselves, are stable.
Every write is draft-scoped: a published app is not addressable for writing, so edit a draft and then publish it with v2-publish-draft. Commands that act on a named draft take the draft identifier as an argument; the -auto-draft commands create or reuse the document’s main draft in the same call, so you don’t have to track one. v2-put-app sends the full HTML body. v2-patch-app sends htmlEdits instead: 1 to 20 edit objects applied in order, each with a required search string, a required replace string, and an optional replaceAll boolean. Patches are all-or-nothing - an edit that matches zero times, or more than once without replaceAll, rejects the whole request and changes nothing. The patch commands never create an app. If there’s no app to edit, they return a 409. To create the first app on a workbook-only document, use v2-put-app or v2-put-app-auto-draft. App writes are last-write-wins, with no version precondition, and each write appends a revision to the app’s history. HTML is capped at 2 MiB, so pass a full app body from a file with --body @app.json rather than inline. See JSON requests and responses for the other ways to supply a body. Writes return a non-blocking warning for external script and stylesheet hosts outside your organization’s app policy. The write succeeds, but the render-time content security policy blocks the host in the browser until an organization admin allows it.
Every command in this group also accepts the global flags, including --token, --profile, --format, and --compact.