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

# Update Dashboard

`PUT /v1/dashboards/{dashboard_id}`

Rename a dashboard or change its description (empty string clears it).

## Path parameters

- `dashboard_id` string, required

## Headers

- `X-API-Key` string, required

## Request body

- UpdateDashboardBody
  - `name` string, nullable
  - `description` string, nullable — Empty string clears the description

## Response `200`

Successful Response

- DashboardModel
  - `id` string, required
  - `organization_id` string, nullable
  - `name` string, required
  - `description` string, nullable
  - `is_curated` boolean
  - `created_by` string, nullable
  - `created_at` string, nullable
  - `data_type` string, required
  - `agent_id` integer, nullable
  - `url` string, nullable — Link to this dashboard in the Bluejay app

## Other responses

- `422` — Validation Error

## Changes

- **2026-08-28** `bf69ab7268a4` — 1 info
  - added the optional property `url` to the response with the `200` status
- **2026-07-26** `44d183272ce1` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/getbluejay/apis/bluejay-api/changes/v1/dashboards/:dashboard_id/put.md)

---

[API](https://skmtc.dev/getbluejay/apis/bluejay-api.md) · [All operations](https://skmtc.dev/getbluejay/apis/bluejay-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getbluejay/bluejay-api/revisions/bf69ab7268a4/schema)