---
title: "Update Dataset"
method: PATCH
path: "/api/v3/dataset/{dataset_id}"
tags: ["Dataset"]
---

# Update Dataset

`PATCH /api/v3/dataset/{dataset_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/dataset/{dataset_id}`
- Auth: HTTP bearer

Update Dataset.

## Path parameters

- `dataset_id` string, required

## Request body

- UpdateDatasetInput
  - `allowCustomFieldDeletion` boolean: When true, custom fields present on the object but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.
  - `archiveReason` string: Why it is being archived. Required when `archived` is `true`, and not allowed when unarchiving.
  - `archived` boolean: Set to `true` to archive or `false` to unarchive it. Archiving requires `archiveReason`.
  - `customFields` UpdateDatasetInputCustomFields
  - `folderId` string
  - `name` string

## Response `200`

OK

- Dataset: `Dataset` stores non-schematized tabular data, with Benchling-aware column types. Datasets are first-class, searchable, archivable folder items. A Dataset's actual data is stored in a `DataFrame`.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime
  - `creator` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `customFields` CustomField[], nullable
    - `__typename` string
    - `name` string, nullable
    - `value` string, nullable
  - `dataFrameId` string, nullable
  - `displayId` string, nullable: A human-readable identifier for this dataset (e.g. "DATASET-1"). Automatically generated and unique within the tenant.
  - `folder` FolderRef
    - `__typename` string
    - `id` string, api_id
  - `id` string
  - `modifiedAt` string, datetime
  - `name` string, nullable

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)