BEbenchling
App Canvas

Update AppCanvas

Update AppCanvas.

patch/api/v3/app-canvas/{app_canvas_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

app_canvas_idstring required

ID of the AppCanvas.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

datastring nullable

JSON string (max 5 KiB) of app-managed data not rendered in the canvas UI.

enabledboolean

Whether the canvas is interactable. When false, all blocks are disabled regardless of their individual enabled settings.

sessionIdstring nullable

App session ID whose status messages are shown in the canvas.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
datastring nullable
enabledboolean
featureIdstring nullable
idstring
modifiedAtstring datetime
resourceIdstring
sessionIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.