OMomni
Apps

Create/reuse draft and replace app content

Changed on
<Note> This API is currently in development and may change. </Note>

Create or reuse the document's main draft and replace the existing app. Use the draftIdentifier in the response to call the Publish draft API and publish the changes.

put/v2/documents/{documentId}/draft/app

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v2/documents/{documentId}/draft/app
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

documentIdstring required

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

Example:abc123

Query parameters

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Request body

htmlstring required

The complete app HTML document. Replaces the current HTML; capped at 2 MiB of UTF-8. maxLength counts characters — the byte cap is what the server enforces. Every write appends an immutable revision.

Response

Draft created or reused and app written. Use the draftIdentifier in the response to call the Publish draft API and publish the changes.

identifierstring required

Published document identifier the draft targets.

draftIdentifierstring required

Identifier of the draft the patch was applied to.

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.

Example response

{
  "identifier": "def456",
  "draftIdentifier": "abc123",
  "name": "Blob Sales",
  "description": "Overview of daily Blobs R Us Sales"
}

Changes