NOnocodb
Dashboards

Update Widget

Update the specified widget.

Note: Widget APIs are available on cloud-hosted Enterprise plans, and on licensed self-hosted deployments (Business plan and above).

patch/api/v3/meta/bases/{baseId}/dashboards/{dashboardId}/widgets/{widgetId}

Request

Path parameters

baseIdstring required

Unique identifier for the base.

dashboardIdstring required

Unique identifier for the dashboard.

widgetIdstring required

Unique identifier for the widget.

Request body

titlestring

Title of the widget.

descriptionstring nullable

Description of the widget.

ordernumber

Display order of the widget.

table_idstring nullable

Unique identifier for the associated table.

view_idstring nullable

Unique identifier for the associated view.

Response

Widget updated.

idstring required

Unique identifier for the widget.

titlestring required

Title of the widget.

descriptionstring nullable

Description of the widget.

dashboard_idstring required

Unique identifier for the parent dashboard.

type'chart' | 'metric' | 'gauge' | 'table' | 'pivot' | 'text' | 'iframe' required

Type of the widget. gauge, table and pivot widgets are returned here but cannot yet be created or updated through this API — create them in the dashboard editor.

ordernumber nullable

Display order of the widget.

table_idstring nullable

Unique identifier for the associated table.

view_idstring nullable

Unique identifier for the associated view.

errorboolean

Whether the widget has a configuration error.

created_atstring date-time required

Timestamp when the widget was created.

updated_atstring date-time required

Timestamp when the widget was last updated.

Changes

No recorded changes to this operation across all 4 revisions of this API.