Edit

[POST] .../v1/dashboard/edit

Edits a dashboard. Rename a dashboard or change its fixed flag without changing dashboard-level firm, stock or period filters. Requires dashboard ownership or dashboard all-edit permission. Fixed and system dashboard restrictions still apply; returns row_affected. The request body is required, id must be positive, name is optional but limited to 50 characters when provided and omitted fields are left unchanged. Errors such as missing body, invalid id, long name, missing dashboard, denied access, fixed dashboard restrictions, no editable fields, storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Dashboard ID.
is_fixed Boolean Optional Fixed dashboard flag. Omit or pass null to leave the flag unchanged.
name String Optional New dashboard name, up to 50 characters. Omit or pass null to leave the name unchanged.

Request Example

{
  "id": 3,
  "name": "Sales overview Q2",
  "is_fixed": false
}

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
  }
}