Update a canvas

Update fields on a canvas.

patch/v1/canvases/:canvas_key

Request

Base URL
https://api.app.count.co/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/count/apis/count-public-api/docs/v1/canvases/:canvas_key/patch.ts
A function with typed inputs. Its response is checked against the schema.

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

No recorded changes to this operation across all 4 revisions of this API.