---
title: "Update Canvas"
method: PATCH
path: "/api/canvases/{canvas_id}"
tags: ["canvas"]
---

# Update Canvas

`PATCH /api/canvases/{canvas_id}`

## Request

- Base URL: `https://api.tintin-x.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tintin-x.com/api/canvases/{canvas_id}`
- Auth: HTTP bearer

Update canvas name, description, or HTML. Only the creator can edit.

## Path parameters

- `canvas_id` string, uuid, required

## Request body

- CanvasUpdateRequest
  - `name` string, nullable
  - `description` string, nullable
  - `html_content` string, nullable

## Response `200`

Successful Response

- CanvasResponse
  - `id` string, uuid, required
  - `program_id` string, uuid, required
  - `created_by` string, uuid, required
  - `created_by_agent` string, uuid, nullable
  - `name` string, required
  - `description` string, nullable, required
  - `created_at` string, date-time, required
  - `html_url` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tintin-x/apis/tintin-api.md) · [All operations](https://skmtc.dev/tintin-x/apis/tintin-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tintin-x/apis/tintin-api/revisions/8839a8d0a66c?raw)