[POST] .../v1/widget/edit
Edits a widget. Use this method to rename an existing widget without changing its dashboard, type, filters or grid position. The method loads the widget and dashboard, checks creator ownership or the dashboard all-edit permission, rejects protected system or fixed dashboards, updates the widget name, writes an action log record, clears widget cache and returns row_affected. The request body is required, id must be positive and name is required with a maximum length of 100 characters. Business errors such as missing body, invalid id, missing or long name, missing widget or dashboard, denied access, system or fixed dashboard restrictions, database errors, transaction failures and action-log failures are returned as HTTP 200 ErrorResult.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | Int64 | Required | Widget ID. |
| name | String | Required | New widget name, up to 100 characters. |
Request Example
{
"id": 15,
"name": "Retail sales today"
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Update | Update operation result. |
Response Example
{
"ok": true,
"result": {
"row_affected": 1,
"ids": []
}
}