---
title: "PATCH /api/dashboard/widgets/{widget_id}/"
method: PATCH
path: "/api/dashboard/widgets/{widget_id}/"
tags: ["Dashboard widgets"]
---

# PATCH /api/dashboard/widgets/{widget_id}/

`PATCH /api/dashboard/widgets/{widget_id}/`

Updates an existing dashboard widget.

## Path parameters

- `widget_id` integer, required

## Headers

- `ClientSessionId` string, uuid
- `ClientUndoRedoActionGroupId` string, uuid

## Request body

- union
  - SummaryWidgetUpdateWidget
    - `title` string
    - `description` string
  - ChartWidgetUpdateWidget
    - `title` string
    - `description` string
    - `series_config` ChartSeriesConfig[] — Provides series configuration.
      - `series_id` integer, required
      - `series_chart_type` 'BAR' | 'LINE', required — * `BAR` - Bar * `LINE` - Line
    - `default_series_chart_type` 'BAR' | 'LINE' — * `BAR` - Bar * `LINE` - Line
  - PieChartWidgetUpdateWidget
    - `title` string
    - `description` string
    - `series_config` PieChartSeriesConfig[] — Provides series configuration.
      - `series_id` integer, required
      - `series_chart_type` 'PIE' | 'DOUGHNUT', required — * `PIE` - Pie * `DOUGHNUT` - Doughnut
    - `default_series_chart_type` 'PIE' | 'DOUGHNUT' — * `PIE` - Pie * `DOUGHNUT` - Doughnut

## Response `200`

- union
  - SummaryWidgetWidget — Basic widget serializer mostly for returned values.
    - `id` integer, required
    - `title` string, required
    - `description` string, required
    - `dashboard_id` integer, required
    - `type` string, required — The type of the widget.
    - `order` string, decimal, required — Lowest first.
    - `data_source_id` integer — References a data source field for the widget.
  - ChartWidgetWidget — Basic widget serializer mostly for returned values.
    - `id` integer, required
    - `title` string, required
    - `description` string, required
    - `dashboard_id` integer, required
    - `type` string, required — The type of the widget.
    - `order` string, decimal, required — Lowest first.
    - `data_source_id` integer — References a data source field for the widget.
    - `series_config` ChartSeriesConfig[] — Provides series configuration.
      - `series_id` integer, required
      - `series_chart_type` 'BAR' | 'LINE', required — * `BAR` - Bar * `LINE` - Line
    - `default_series_chart_type` 'BAR' | 'LINE' — * `BAR` - Bar * `LINE` - Line
  - PieChartWidgetWidget — Basic widget serializer mostly for returned values.
    - `id` integer, required
    - `title` string, required
    - `description` string, required
    - `dashboard_id` integer, required
    - `type` string, required — The type of the widget.
    - `order` string, decimal, required — Lowest first.
    - `data_source_id` integer — References a data source field for the widget.
    - `series_config` PieChartSeriesConfig[] — Provides series configuration.
      - `series_id` integer, required
      - `series_chart_type` 'PIE' | 'DOUGHNUT', required — * `PIE` - Pie * `DOUGHNUT` - Doughnut
    - `default_series_chart_type` 'PIE' | 'DOUGHNUT' — * `PIE` - Pie * `DOUGHNUT` - Doughnut

## Other responses

- `400`
- `401`
- `404`

---

[API](https://skmtc.net/baserow/apis/baserow-api-spec.md) · [All operations](https://skmtc.net/baserow/apis/baserow-api-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/baserow/baserow-api-spec/versions/0c490e5b0c7f/schema)