> ## Documentation Index
> Fetch the complete documentation index at: https://widgetic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete Canvas

> Deletes a canvas together with every widget on it.

Called with an editor session, only a canvas whose widgets were all made for the session's managed user can
be deleted; one that also holds somebody else's widgets is refused with 409 and `CANVAS_HAS_OTHER_WIDGETS`,
and nothing is deleted. Delete such a canvas with your API key.




## OpenAPI

````yaml /openapi/widgetic-api-public.json delete /canvases/{id}
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /canvases/{id}:
    delete:
      tags:
        - Canvases
      summary: Delete Canvas
      description: >
        Deletes a canvas together with every widget on it.


        Called with an editor session, only a canvas whose widgets were all made
        for the session's managed user can

        be deleted; one that also holds somebody else's widgets is refused with
        409 and `CANVAS_HAS_OTHER_WIDGETS`,

        and nothing is deleted. Delete such a canvas with your API key.
      operationId: deleteCanvas
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the canvas
      responses:
        '200':
          description: >-
            Canvas deleted successfully. `data` is the canvas as it was when it
            was removed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CanvasResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Canvas not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            A widget on the canvas could not be deleted
            (`WIDGET_DELETE_FAILED`), or an editor session tried to delete a
            canvas that also holds somebody else's widgets
            (`CANVAS_HAS_OTHER_WIDGETS`). The canvas is left intact.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    CanvasResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          description: Always `true` on a success.
          example: true
        data:
          $ref: '#/components/schemas/Canvas'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    Canvas:
      type: object
      required:
        - id
        - persistenceKey
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the canvas
          example: 123e4567-e89b-12d3-a456-426614174000
        persistenceKey:
          type: string
          description: Key used for persistent storage and reference
          example: canvas_xyz123
        canvasContent:
          type: object
          description: JSON content of the canvas, containing layout and configuration
          example:
            version: 1
            elements: []
            settings: {}
        creatorId:
          type: string
          format: uuid
          description: UUID of the user who created the canvas
        primaryWidgetId:
          type: string
          format: uuid
          nullable: true
          description: >-
            Primary widget for My widgets list and canvas-only deep-link
            (Convert per shape may add secondary widgets on the same canvas)
          example: 123e4567-e89b-12d3-a456-426614174099
        managedUserId:
          type: string
          format: uuid
          nullable: true
          description: >-
            The managed user the canvas was made for (Widgetic's id for the
            user); null for a canvas that is the account's own.
          example: 123e4567-e89b-12d3-a456-426614174077
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the canvas was created
          example: '2023-01-01T00:00:00Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the canvas was last updated
          example: '2023-01-02T00:00:00Z'
      example:
        id: 123e4567-e89b-12d3-a456-426614174000
        persistenceKey: canvas_xyz123
        canvasContent:
          version: 1
          elements: []
          settings: {}
        creatorId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        primaryWidgetId: 123e4567-e89b-12d3-a456-426614174099
        managedUserId: 123e4567-e89b-12d3-a456-426614174077
        createdAt: '2023-01-01T00:00:00Z'
        updatedAt: '2023-01-02T00:00:00Z'
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.