OMomni
Documents v2

Create and publish document

Changed on

Create and publish a brand-new document.

Because this is the first publication of brand-new content, it is not subject to the organization's requirePullRequestToPublish policy, which gates edits to existing content.

post/v2/documents

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v2/documents
  • Auth
    HTTP bearer

Request body

modelIdstring uuid required

Base workbook model the document is built on — a SHARED model, or a SHARED_EXTENSION with allowAsWorkbookBase = true.

namestring required

Document name.

identifierstring

Identifier (URL slug) for the new document. Must be unique within the organization; auto-generated when omitted. Lowercase letters, numbers, hyphens, and underscores only; cannot start or end with a hyphen or underscore.

descriptionstring nullable

Document description.

folderIdstring uuid nullable

The folder to create the document in; Editor permissions or higherer are required on this folder. Does not apply to Organization Admins.

When omitted, defaults to the caller's personal My documents, which requires permission to save personal content or the request is rejected.

summarystring

Caller-supplied note describing the create, written to the history audit trail. When omitted, Omni auto-fills it with "Created document".

containersobject[]

Container layout array (grid / stack / page / reference containers, recursively nested). On a patch, when present this fully replaces the existing layout. The server validates the full structure on apply; container instanceKey / referenceKey values round-trip unchanged. See the dashboard layout reference for the complete grammar.

Response

Document created and published successfully.

identifierstring required

Identifier of the newly created document.

namestring required

Document name.

descriptionstring nullable required

Document description.

warningsstring[]

Included only when non-blocking warnings are encountered when creating/updating an app. The write itself succeeded.

Changes

  • 43290040f88fRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property /

    • info

      added the new foreign enum value to the request property ///////

    • info

      added the optional property to the response with the status