> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Dataset

> Update a custom KPI dataset's name or description

# Update Dataset

Update the name or description of an existing custom KPI dataset. Only send the fields you want to change.

<Note>
  To manage the KPIs within a dataset, use the [KPI endpoints](/api-reference/custom-kpi/overview) (create, update, delete KPIs individually).
</Note>

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

### Path Parameters

<ParamField path="dataset_id" type="string" required>
  UUID of the dataset to update

  **Example:** `"a1b2c3d4-e5f6-7890-abcd-ef1234567890"`
</ParamField>

### Body Parameters

All fields are optional — only send what you want to change.

<ParamField body="name" type="string">
  New dataset name (1–255 characters)
</ParamField>

<ParamField body="description" type="string">
  New dataset description (max 2000 characters)
</ParamField>

## Response

Returns the updated dataset with its KPI definitions (HTTP 200). See [Get Dataset](/api-reference/custom-kpi/get-dataset) for the full response shape.

<ResponseField name="id" type="string">
  Dataset UUID.
</ResponseField>

<ResponseField name="name" type="string">
  Dataset display name.
</ResponseField>

<ResponseField name="description" type="string | null">
  Dataset description.
</ResponseField>

<ResponseField name="kpis" type="array[object]">
  KPI definitions. See [Get Dataset](/api-reference/custom-kpi/get-dataset) for the nested KPI object shape.
</ResponseField>

<ResponseField name="created_at" type="datetime">
  Creation timestamp (ISO 8601).
</ResponseField>

<ResponseField name="updated_at" type="string | null">
  Last update timestamp (ISO 8601).
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X PATCH "https://api.dcycle.io/v1/custom-kpi-datasets/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}" \
    -H "Content-Type: application/json" \
    -d '{"name": "Water & Waste Survey 2025", "description": "Updated to include waste metrics"}'
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  headers = {
      "x-api-key": os.getenv("DCYCLE_API_KEY"),
      "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
      "Content-Type": "application/json",
  }

  dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

  response = requests.patch(
      f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}",
      headers=headers,
      json={"name": "Water & Waste Survey 2025", "description": "Updated to include waste metrics"},
  )

  dataset = response.json()
  print(f"Updated: {dataset['name']}")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const headers = {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
    'Content-Type': 'application/json',
  };

  const id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';

  axios.patch(`https://api.dcycle.io/v1/custom-kpi-datasets/${id}`, {
    name: 'Water & Waste Survey 2025',
    description: 'Updated to include waste metrics',
  }, { headers })
  .then(response => console.log(`Updated: ${response.data.name}`));
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
  "name": "Water & Waste Survey 2025",
  "description": "Updated to include waste metrics",
  "created_by": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "updated_by": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "created_at": "2025-05-01T09:00:00Z",
  "updated_at": "2025-06-18T14:30:00Z"
}
```

## Common Errors

### 401 Unauthorized

**Cause:** Missing or invalid API key

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
```

### 403 Forbidden

**Cause:** The authenticated user is not a member of the organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
```

### 404 Not Found

**Cause:** Dataset not found

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": "Dataset not found"
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Get Dataset" icon="magnifying-glass" href="/api-reference/custom-kpi/get-dataset">
    View current dataset details
  </Card>

  <Card title="List Datasets" icon="list" href="/api-reference/custom-kpi/list-datasets">
    View all datasets
  </Card>
</CardGroup>