Skip to main content
PATCH
/
api
/
datasets
/
{dataset_id}
Update Dataset Metadata
curl --request PATCH \
  --url https://api.example.com/api/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "current_version": {
    "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 123,
    "status": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Key
string | null

Path Parameters

​
dataset_id
string<uuid>
required

Body

application/json

Request to update dataset metadata.

​
name
string | null
​
description
string | null

Response

Successful Response

Dataset response model.

​
dataset_id
string<uuid>
required
​
name
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
current_version
CurrentVersion · object

Current version summary.