Skip to main content
PUT
Replace app content on a draft

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

draftId
string
required

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

Example:

"def456"

documentId
string
required

Published document identifier.

Example:

"abc123"

Body

application/json
html
string
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.

Required string length: 1 - 2097152
settings
object

When present, replaces the app settings; omitted fields take their locked-down defaults. When absent, the current settings are retained.

Response

App written on the draft.

identifier
string
required

Published document identifier the draft targets.

Example:

"def456"

draftIdentifier
string
required

Identifier of the draft the patch was applied to.

Example:

"abc123"

name
string
required

Document name.

Example:

"Blob Sales"

description
string | null
required

Document description.

Example:

"Overview of daily Blobs R Us Sales"

app
object
required
warnings
string[]

Included only when non-blocking warnings are encountered. Currently, external resource hosts the app's iframe CSP will block until an Organization Admin allows them. The write itself succeeded.