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

# PATCH /api/dashboard/{dashboard_id}/widgets/layout/

`PATCH /api/dashboard/{dashboard_id}/widgets/layout/`

## Request

- Base URL: `https://api.baserow.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.baserow.io/api/dashboard/{dashboard_id}/widgets/layout/`
- Auth: HTTP bearer

Atomically updates and vertically compacts the layout of every dashboard widget visible to the current user.

## Path parameters

- `dashboard_id` integer, required

## Headers

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

## Request body

- PatchedUpdateWidgetLayout
  - `widgets` WidgetLayoutItem[]: The complete layout of the dashboard widgets visible to the current user. It is vertically compacted before being persisted.
    - `id` integer, required
    - `grid_x` integer, required
    - `grid_y` integer, required
    - `grid_width` integer, required
    - `grid_height` integer, required

## Response `200`

- DashboardWidgetWidget[]
  - 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.
      - `grid_x` integer, required
      - `grid_y` integer, required
      - `grid_width` integer, required
      - `grid_height` integer, required
      - `grid_layout` WidgetGridLayout, required
        - `default_width` integer, required
        - `default_height` integer, required
        - `min_width` integer, required
        - `min_height` integer, required
        - `max_width` integer, required
        - `max_height` integer, required
      - `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.
      - `grid_x` integer, required
      - `grid_y` integer, required
      - `grid_width` integer, required
      - `grid_height` integer, required
      - `grid_layout` WidgetGridLayout, required
        - `default_width` integer, required
        - `default_height` integer, required
        - `min_width` integer, required
        - `min_height` integer, required
        - `max_width` integer, required
        - `max_height` integer, required
      - `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.
      - `grid_x` integer, required
      - `grid_y` integer, required
      - `grid_width` integer, required
      - `grid_height` integer, required
      - `grid_layout` WidgetGridLayout, required
        - `default_width` integer, required
        - `default_height` integer, required
        - `min_width` integer, required
        - `min_height` integer, required
        - `max_width` integer, required
        - `max_height` integer, required
      - `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`

## Changes

- **2026-09-30** `e81714236040`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/baserow/apis/baserow-api-spec/changes/api/dashboard/:dashboard_id/widgets/layout/patch.md)

---

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