---
title: "Edit a dashboard"
method: PATCH
path: "/api/v1/public/dashboards/{dashboard_id}"
tags: ["Dashboards"]
---

# Edit a dashboard

`PATCH /api/v1/public/dashboards/{dashboard_id}`

## Request

- Base URL: `https://app.traceroot.ai`
- URL: `https://app.traceroot.ai/api/v1/public/dashboards/{dashboard_id}`
- Auth: HTTP bearer

Edit a dashboard's name or description.

Requires MEMBER role or higher in the project's workspace (the write
service decides). A null ``description`` clears it.

Args:
    request (Request): Incoming request (rate-limit plumbing).
    response (Response): Outgoing response (rate-limit plumbing).
    auth (AccountStampedAuth): Account-scope user auth (session token or
        CLI access JWT); its resolved ``user_id`` becomes the actor.
    dashboard_id (str): The dashboard to edit.
    payload (UpdateDashboardRequest): The project and the fields to change.
    _live (None): Write-path liveness gate (blocks a revoked JWT session).

Returns:
    UpdateDashboardResponse: The updated dashboard and the changed fields.

Raises:
    HTTPException: The write service's 400/403/404/409 verbatim, or a
        503 when its response is ambiguous.

## Path parameters

- `dashboard_id` string, required

## Request body

- UpdateDashboardRequest: Body for editing a dashboard's name or description (layout stays UI-only).
  - `description` string, nullable: null clears the description
  - `name` string
  - `project_id` string, required

## Response `200`

Successful Response

- UpdateDashboardResponse: The updated dashboard.
  - `changed` string[], required
  - `dashboard` DashboardRow, required: A dashboard as the write service returns it.
    - `id` string, required
    - `name` string, required
    - `project_id` string, required
  - `updated` boolean, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failed or session revoked
- `403`: Insufficient role or wrong credential kind
- `404`: Not found
- `409`: Name already in use
- `422`: Validation Error
- `503`: Write service unavailable

---

[API](https://skmtc.dev/traceroot/apis/traceroot-public-api.md) - [All operations](https://skmtc.dev/traceroot/apis/traceroot-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/traceroot/apis/traceroot-public-api/revisions/ce6aef96c0d6?raw)