Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Canvases

Partially update a canvas by ID.

Update one or more editable fields of an existing canvas.

  • Only the provided fields will be modified.
  • Non-editable fields (such as id, company_id, and timestamps) are ignored if included.
  • Returns the updated canvas representation.
patch/canvases/{id}

Path parameters

idstring required

Request body

idstring uuid
namestring
descriptionstring nullable
sharing_scheme'ALL' | 'MANAGERS' | 'SPECIFIC'
  • ALL - All Team Members
  • MANAGERS - Managers Only
  • SPECIFIC - Specific Users
source'WORKSPACE' | 'DECKS' | 'MCP' | 'PLAN_MODE' | 'BUILDER'
  • WORKSPACE - Workspace
  • DECKS - Decks
  • MCP - MCP
  • PLAN_MODE - Plan Mode
  • BUILDER - Builder
{"stackTrail":"components:schemas:PatchedCanvas:properties:filters","oasType":"schema","type":"unknown"}
default_currency_idinteger nullable
shared_withstring[]
is_likedboolean
created_atstring date-time
modified_atstring date-time

Response

idstring uuid required
namestring required
descriptionstring nullable
sharing_scheme'ALL' | 'MANAGERS' | 'SPECIFIC'
  • ALL - All Team Members
  • MANAGERS - Managers Only
  • SPECIFIC - Specific Users
source'WORKSPACE' | 'DECKS' | 'MCP' | 'PLAN_MODE' | 'BUILDER'
  • WORKSPACE - Workspace
  • DECKS - Decks
  • MCP - MCP
  • PLAN_MODE - Plan Mode
  • BUILDER - Builder
{"stackTrail":"components:schemas:Canvas:properties:filters","oasType":"schema","type":"unknown"}
default_currency_idinteger nullable
shared_withstring[]
is_likedboolean required
created_atstring date-time required
modified_atstring date-time required