---
title: "Update a canvas area"
method: PATCH
path: "/canvas-areas/{canvasAreaId}"
tags: ["canvas-areas"]
---

# Update a canvas area

`PATCH /canvas-areas/{canvasAreaId}`

Updates an existing canvas area

## Path parameters

- `canvasAreaId` string, required — Canvas Area ID

## Headers

- `Authorization` string, required
- `X-Disable-Hooks` 'true', required

## Request body

- object
  - `type` 'mapping' | 'header' | 'agent' | 'form' | 'sheet' | 'sheets' | 'workbook' | 'document' | 'file' | 'iframe'
  - `position` 'top' | 'left' | 'right' | 'middle' | 'bottom'
  - `visibility` 'visible' | 'hidden' | 'optional' | 'skeleton'
  - `layout` 'split' | 'drawer' | 'modal'
  - `overlay` unknown
  - `config` unknown
  - `metadata` unknown
  - `parentId` string — Canvas Area ID
  - `canvasId` string — Canvas ID

## Response `200`

Response with status 200

- TypeCanvasAreasCanvasAreaResponse
  - `data` TypeCanvasAreasCanvasArea, required — A canvas area represents a section within a canvas for organizing content
    - `id` string, required — Canvas Area ID
    - `canvasId` string, required — Canvas ID
    - `parentId` string — Canvas Area ID
    - `config` unknown, required
    - `metadata` unknown, required
    - `layout` 'split' | 'drawer' | 'modal', required
    - `overlay` unknown, required
    - `type` 'mapping' | 'header' | 'agent' | 'form' | 'sheet' | 'sheets' | 'workbook' | 'document' | 'file' | 'iframe', required
    - `position` 'top' | 'left' | 'right' | 'middle' | 'bottom', required
    - `visibility` 'visible' | 'hidden' | 'optional' | 'skeleton', required
    - `createdAt` string, date-time, required — When the canvas area was created
    - `updatedAt` string, date-time, required — When the canvas area was last updated
    - `deletedAt` string, date-time — When the canvas area was deleted, if applicable

## Other responses

- `400` — Error response with status 400
- `404` — Error response with status 404

---

[API](https://skmtc.net/flatfile/apis/api-reference.md) · [All operations](https://skmtc.net/flatfile/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flatfile/api-reference/revisions/9d3a9979cd96/schema)