Delete

[POST] .../v1/dashboard/delete

Deletes a dashboard. Soft-delete a custom dashboard and remove its widget and user-dashboard assignments. The method loads the dashboard, checks creator ownership or the dashboard all-delete permission, rejects protected system/default dashboards, marks the dashboard and its widgets deleted, resets the current user's default assignment to the system dashboard and returns row_affected. The request body is required and id must be positive; callers usually verify the dashboard with Dashboard/Get and inspect assignments with UserDashboard/Get before deleting. Errors such as missing body, invalid id, missing dashboard, denied access, protected system or default dashboard, storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Record ID.

Request Example

{
  "id": 3
}

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