---
title: "Update a sheet"
method: PATCH
path: "/v1/sheets/{sheet_id}"
tags: ["Sheets"]
---

# Update a sheet

`PATCH /v1/sheets/{sheet_id}`

Update the name and/or custom_metadata of a sheet.

## Path parameters

- `sheet_id` integer, required

## Request body

- union
  - object
    - `name` string, required — The new name of the sheet.
    - `custom_metadata` object, nullable — Custom metadata associated with the sheet. Must be a flat object with non-reserved keys.
  - object
    - `name` string — The new name of the sheet.
    - `custom_metadata` object, nullable, required — Custom metadata associated with the sheet. Must be a flat object with non-reserved keys.

## Response `200`

The request has succeeded.

- SheetResource
  - `id` integer, required — The unique identifier of the sheet.
  - `workspace_id` integer, required — The id of the Workspace that contains the sheet.
  - `name` string, required — The name of the sheet.
  - `template_key` string, nullable — The unique key of the template assigned to the sheet, if any.
  - `custom_metadata` object, nullable — Custom metadata associated with the sheet.
  - `columns` SheetColumn[] — The columns of the sheet, included when the sheet's headers have been set.
    - `id` integer, required — The unique identifier of the column.
    - `name` string, required — The label of the column.
    - `template_column_key` string, nullable — The key of the template column this sheet column is mapped to, if any.
    - `is_custom` boolean — Whether the column is a custom column not present in the assigned template.

## Other responses

- `400` — 400

---

[API](https://skmtc.net/oneschema/apis/templates.md) · [All operations](https://skmtc.net/oneschema/apis/templates/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneschema/templates/versions/40674aa6d4d9/schema)