---
title: "Update Dashboard"
method: PUT
path: "/v1/dashboards/{dashboardId}"
tags: ["Dashboards"]
---

# Update Dashboard

`PUT /v1/dashboards/{dashboardId}`

## Request

- Base URL: `https://api.confident-ai.com`
- URL: `https://api.confident-ai.com/v1/dashboards/{dashboardId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/docs/v1/dashboards/:dashboardId/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates a dashboard's metadata and returns the id of the updated dashboard. Only the provided fields are changed.

## Path parameters

- `dashboardId` string, required

## Request body

- UpdateDashboardRequest: Partial update. At least one field must be provided.
  - `name` string: The dashboard's new name.
  - `description` string, nullable: The dashboard's new description.
  - `private` boolean: Whether the dashboard is private to its creator.

## Response `200`

The id of the updated dashboard.

- DashboardIdResponse
  - `success` boolean, required: Indicates if the request was successful.
  - `data` object, required: The id of the affected dashboard or widget.
    - `id` string, required: The id of the affected dashboard or widget.
  - `deprecated` boolean, required: Indicates if this endpoint is deprecated.

## Changes

> 54 revisions in range; 3 not diffed.

- **2026-06-30** `8b6c262fba71`: 1 info
  - endpoint added
- **2026-06-29** `a3c9e9461f9c`: 1 breaking
  - api path removed without deprecation
- **2026-06-29** `77c4156f18d2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/changes/v1/dashboards/:dashboardId/put.md)

---

[API](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api.md) - [All operations](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/revisions/95cdde71b65e?raw)