---
title: "Update Dashboard"
method: PATCH
path: "/console/v1/dashboards/{id}"
tags: ["Dashboards"]
---

# Update Dashboard

`PATCH /console/v1/dashboards/{id}`

## Request

- Base URL: `https://statsigapi.net`
- URL: `https://statsigapi.net/console/v1/dashboards/{id}`
- Auth: API key in header `STATSIG-API-KEY`

Update dashboard name, description, or defaults. Include the revision from an editable or references read. Omitted fields remain unchanged; an empty description clears it and defaults:null resets dashboard defaults. Read again after a revision conflict.

## Path parameters

- `id` string, required

## Request body

- UpdateDashboardDto
  - `revision` string, required: Include the `revision` returned by an editable or references read. Read the dashboard again after a revision conflict.
  - `name` string
  - `description` string: Set an empty string to clear the dashboard description.
  - `defaults` object, nullable: Update only the supplied defaults. Set `null` to reset to 30 days and daily granularity.
    - `date` union
      - object
        - `value` integer, required
        - `unit` 'day' | 'week' | 'month', required
      - object
        - `mode` 'chart_default', required
      - object
        - `mode` 'since', required
        - `since_ms` number, required
      - object
        - `mode` 'relative', required
        - `value` number, required
        - `unit` 'minute' | 'hour' | 'day', required
    - `granularity` 'auto' | 'daily' | 'weekly' | 'monthly'

## Response `200`

Updated dashboard identity and revision.

- object
  - `message` string, required: A simple string explaining the result of the operation.
  - `data` object, required: A single result.
    - `id` string, required
    - `revision` string, required

## Other responses

- `400`: Invalid request. Please check the request input and try again.
- `404`: Not Found. The requested resource could not be found.
- `412`: The revision changed. Read the dashboard again and reapply the edit.

## Changes

- **2026-10-30** `a7f43412fb6b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/statsig/apis/console-api/changes/console/v1/dashboards/:id/patch.md)

---

[API](https://skmtc.dev/statsig/apis/console-api.md) - [All operations](https://skmtc.dev/statsig/apis/console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/statsig/apis/console-api/revisions/605b784f2a7d?raw)