Skip to navigation
Benchling APIApp Canvas

Update AppCanvas

Beta
Update AppCanvas.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

app_canvas_idstringRequired
ID of the AppCanvas.

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
archiveReasonstringOptional
archivedbooleanOptional
blockslist of objectsOptional
Replacement list of UI blocks for the canvas layout.
datastring or nullOptional

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

enabledbooleanOptional
Whether the canvas is interactable. When false, all blocks are disabled regardless of their individual enabled settings.
sessionIdstring or nullOptional
App session ID whose status messages are shown in the canvas.

Response

OK
__typenamestringOptional
appobjectOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
blockslist of objectsOptional
createdAtstringOptional
datastring or nullOptional
enabledbooleanOptional
featureIdstring or nullOptional
idstringOptional
modifiedAtstringOptional
resourceIdstringOptional
sessionIdstring or nullOptional

Errors

400
App Canvas Update Request Bad Request Error
403
App Canvas Update Request Forbidden Error
404
App Canvas Update Request Not Found Error
409
App Canvas Update Request Conflict Error
429
App Canvas Update Request Too Many Requests Error
500
App Canvas Update Request Internal Server Error