v1

latestOpenAPI 3.1.02026-08-063512102.9 KB

Update a canvas

Update fields on a canvas.

patch/v1/canvases/:canvas_key

canvas_keystring required

The unique identifier for the canvas

namestring

The display name for the canvas

automatic_cell_executionboolean

Whether cells in this canvas execute automatically or not.

cache_durationnumber nullable

The cache duration time for this canvas in seconds.

refresh_schedulestring nullable

A cron expression representing the query refresh schedule.

tagsstring[]

The tags for this canvas.

in_trashboolean

Whether the canvas is in the trash. Use true to put the canvas in the trash, or false to remove it from the trash.

Successful response

successtrue required

request_idstring required