CUcubesoftware
Canvases

Partially update a canvas by ID.

Changed on

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}

Request

  • Base URL
    https://api.cubesoftware.com
  • Auth
    OAuth 2
    Authorization code: https://portal.cubesoftware.com/o/authorize/
    Token URL: https://api.cubesoftware.com/o/token/

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
filtersunknown
default_currency_idinteger nullable
folder_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
filtersunknown
default_currency_idinteger nullable
folder_idinteger nullable
shared_withstring[]
is_likedboolean required
created_atstring date-time required
modified_atstring date-time required

Changes

  • 2ef6e2cdfaefRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status