Skip to main content

Visit Later

N/a

General Notes

  • Replaces the former "Rename Canvas" endpoint with broader update capabilities
  • SUPER_ADMIN can update name, displayOrder, widgetLimit, and isDefault (at least one required)
  • AE/CIO can only update name (required) — additionalProperties: false rejects restricted fields
  • SUPER_ADMIN bypasses userId ownership filter; AE/CIO queries are scoped by userId
  • Soft-deleted canvases are excluded (deletedAt: null filter)

Flow

Mermaid editor

Test cases

Method & URL

PATCH v1/canvases/:canvasId

Request

Headers

authorization
  - Required
  - Type : <string>
  - Bearer session token

Query


Body (AE/CIO)

name
  - Required
  - Type : <string>
  - New display name for the canvas
  - Min length: 1, Max length: 100

Body (SUPER_ADMIN)

name
  - Optional
  - Type : <string>
  - New display name for the canvas
  - Min length: 1, Max length: 100

displayOrder
  - Optional
  - Type : <number>
  - Minimum: 0

widgetLimit
  - Optional
  - Type : <number>
  - Minimum: 1

isDefault
  - Optional
  - Type : <boolean>

Note: at least one field must be provided

Path parameter

canvasId
  - Required
  - Type : <string>
  - MongoDB ObjectId (24 hex characters)

Response

2xx

success
  - Type : true (boolean)
  - This indicates that request was executed successfully

message
  - Type : <string> | null
  - null on success

data
  - Type : <object>

data.canvas
  - Type : <object>
  - The updated canvas

data.canvas.id
  - Type : <string>

data.canvas.name
  - Type : <string>

data.canvas.displayOrder
  - Type : <number>

data.canvas.isDefault
  - Type : <boolean>

data.canvas.widgetLimit
  - Type : <number>

400

success
  - Type : false (boolean)

message
  - Type : <string>
  - "Something went wrong. We're on it." (invalid canvasId format)
  - "Tab name is required." (AE/CIO: name missing)
  - "Tab name cannot be empty." (empty name)
  - "Tab name cannot exceed 100 characters." (name too long)
  - "Please provide at least one field to update." (SUPER_ADMIN: no fields provided)
  - "Something went wrong. We're on it." (other system errors)

404

success
  - Type : false (boolean)

message
  - Type : <string>
  - "Canvas not found"