Visit Later

N/a

General Notes

• Performs a soft-delete — sets deletedAt timestamp instead of removing documents
• Cascade soft-deletes all widgets and conversations under the canvas (wrapped in a MongoDB transaction)
• AE/CIO cannot delete the default Energy Audit canvas (isDefault: true); SUPER_ADMIN can
• SUPER_ADMIN bypasses userId ownership filter; AE/CIO queries are scoped by userId
• Soft-deleted canvases are excluded from lookups (deletedAt: null filter)
• A 7-day TTL index on deletedAt auto-purges soft-deleted documents

Flow

Mermaid editor

Test cases

Method & URL

DELETE v1/canvases/:canvasId

Request

Headers

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

Query

Body

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>
  - Empty object

400

success
  - Type : false (boolean)

message
  - Type : <string>
  - "Something went wrong. We're on it." (invalid canvasId format)
  - "Cannot delete the default canvas" (AE/CIO attempting to delete default canvas)

404

success
  - Type : false (boolean)

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