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

# Update Dashboard

`PUT /v1/dashboards/{dashboardId}`

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.

---

[API](https://skmtc.net/confident-ai/apis/confident-ai-metrics-api.md) · [All operations](https://skmtc.net/confident-ai/apis/confident-ai-metrics-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/confident-ai/confident-ai-metrics-api/revisions/95cdde71b65e/schema)