OMomni
Apps

Create/reuse draft and edit app content

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

Create or reuse an existing document's main draft and apply targeted edits to the app's HTML without resending the whole document.

patch/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

OR

Response

Draft created or reused and edits applied. 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