---
title: "Update Widget"
method: PATCH
path: "/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}"
tags: ["dashboards"]
---

# Update Widget

`PATCH /api/v1/dashboards/{dashboard_id}/widgets/{widget_id}`

## Path parameters

- `dashboard_id` integer, required
- `widget_id` integer, required

## Headers

- `authorization` string, nullable
- `X-API-Key` string, nullable

## Request body

- WidgetUpdate — Patch a widget. Every field optional; the kind/report pairing is re-checked against the merged row in the API layer, where the current values are known.
  - `widget_kind` 'report' | 'text', nullable
  - `widget_type` 'bar' | 'line' | 'combi' | 'pie' | 'donut' | 'treemap' | 'metric' | 'gauge' | 'funnel' | 'waterfall' | 'scatter' | 'table' | 'text', nullable
  - `report_id` integer, nullable
  - `position_config` object, nullable
  - `config` WidgetConfig — Per-widget rendering options. Report and text widgets share one config object because they share one column; the fields each kind reads are disjoint and documented below.
    - `use_report_chart` boolean
    - `x` string, nullable
    - `y` string, nullable
    - `series` ChartSeries[], nullable
      - `column` string, required
      - `render` 'bar' | 'line'
      - `axis` 'left' | 'right', nullable
    - `aggregation` 'count' | 'sum' | 'average' | 'percentage', nullable
    - `target` number, nullable
    - `floor` number, nullable
    - `colors` string[], nullable
    - `text` string, nullable
    - `font_family` string, nullable
    - `font_size` integer, nullable
    - `background_color` string, nullable
    - `text_color` string, nullable
  - `title` string, nullable
  - `subtitle` string, nullable
  - `footer` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422` — Validation Error

## Changes

- **2026-08-27** `db5ab8f1fcef` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ninjavan/apis/salesforce-sales-cloud-replacement/changes/api/v1/dashboards/:dashboard_id/widgets/:widget_id/patch.md)

---

[API](https://skmtc.dev/ninjavan/apis/salesforce-sales-cloud-replacement.md) · [All operations](https://skmtc.dev/ninjavan/apis/salesforce-sales-cloud-replacement/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ninjavan/salesforce-sales-cloud-replacement/revisions/ce7abafbb050/schema)