---
title: "Partially update dataset snapshot"
method: PATCH
path: "/v1/dataset_snapshot/{dataset_snapshot_id}"
tags: ["DatasetSnapshots"]
---

# Partially update dataset snapshot

`PATCH /v1/dataset_snapshot/{dataset_snapshot_id}`

## Request

- Base URL: `https://api.braintrust.dev`
- URL: `https://api.braintrust.dev/v1/dataset_snapshot/{dataset_snapshot_id}`
- Auth: one of:
  - HTTP bearer
  - none

Partially update a dataset snapshot object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

## Path parameters

- `dataset_snapshot_id` string, uuid, required: DatasetSnapshot id

## Request body

- PatchDatasetSnapshot
  - `name` string, nullable: Name of the dataset snapshot
  - `description` string, nullable: Textual description of the dataset snapshot

## Response `200`

Returns the dataset snapshot object

- DatasetSnapshot
  - `id` string, uuid, required: Unique identifier for the dataset snapshot
  - `dataset_id` string, uuid, required: Unique identifier for the dataset that this snapshot belongs to
  - `name` string, required: Name of the dataset snapshot
  - `description` string, nullable, required
  - `xact_id` string, required: Transaction id of the brainstore version at the time of the snapshot
  - `created` string, date-time, nullable, required: Date of dataset snapshot creation

## Other responses

- `400`: The request was unacceptable, often due to missing a required parameter
- `401`: No valid API key provided
- `403`: The API key doesn’t have permissions to perform the request
- `429`: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
- `500`: Something went wrong on Braintrust's end. (These are rare.)

## Changes

- **2026-10-30** `8f5039399f77`: 2 breaking
  - the request property `description` became not nullable
  - the request property `name` became not nullable
- **2026-04-08** `a21b724fece9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/braintrustdata/apis/braintrust-api/changes/v1/dataset_snapshot/:dataset_snapshot_id/patch.md)

---

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