OMomni
Apps

Replace app content on a draft

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

Replace the app HTML on an existing draft. If the specified document does not yet have an app, one will be created.

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

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

App written on the draft.

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