OMomni
Apps

Edit app content on a draft

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

Apply targeted changes to an existing app on an existing draft without resending the HTML. Changes are all or nothing — an edit that matches zero times, matches more than once without replaceAll, or would push the HTML past the 2 MiB cap rejects the whole request with 400 naming the edit, and nothing is applied. This endpoint does not create an app.

Use the draftIdentifier in the response to call the Publish draft API and publish the changes.

patch/v2/documents/{documentId}/draft/{draftId}/app

Request

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

Path parameters

draftIdstring required
Example:def456

Draft workbook identifier. Use List document drafts to retrieve draft IDs.

documentIdstring required
Example:abc123

Published document identifier.

Request body

OR

Response

Edits applied on the draft. warnings names any resource hosts the app’s iframe CSP will block until an Organization Admin allows them, and navigation domains the organization’s navigation policy refuses.

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