Delete Dashboard

Permanently delete a dashboard and all of its charts using the Blue API.

Use the deleteDashboard mutation to permanently delete a dashboard, along with the charts and chart segments it contains. Dashboards are Dashboard objects in the API. This is a hard delete — there is no soft-delete or undo — and only the dashboard’s creator can perform it.

Request

mutation DeleteDashboard {
  deleteDashboard(id: "dashboard_123") {
    success
    operationId
  }
}

Parameters

ParameterTypeRequiredDescription
idString!YesIdentifier of the dashboard to delete.

Response

{
  "data": {
    "deleteDashboard": {
      "success": true,
      "operationId": null
    }
  }
}

Returns

deleteDashboard returns a MutationResult.

FieldTypeDescription
successBoolean!true when the dashboard was deleted. Returns false (with no error) if the delete fails internally — see Failure behavior.
operationIdStringIdentifier of the resulting async operation, if one was queued. null for this mutation, which deletes synchronously.

Permissions

The resolver enforces access in two stages, which produce two distinct outcomes:

  1. Access check. The caller must be the creator of the dashboard or have the EDITOR role on it. A caller with neither (including viewers and callers who can’t see the dashboard at all) receives DASHBOARD_NOT_FOUND.
  2. Creator check. Of those who pass the access check, only the creator may delete. An EDITOR who is not the creator receives FORBIDDEN.

There is no role-based override: company owners and admins cannot delete a dashboard created by someone else.

Failure behavior

If the underlying delete fails internally after the permission checks pass, the mutation does not throw — it returns { "success": false }. Always check the success field rather than assuming a non-error response means the dashboard was removed.

Deleting a dashboard publishes a DashboardDeleted event to anyone subscribed to that dashboard’s company, so live clients drop it from their view. It does not affect workspaces, records, or any other company data — only the dashboard, its charts, and its chart segments are removed.

Errors

CodeWhen
DASHBOARD_NOT_FOUNDNo dashboard with that id is visible to the caller, or the caller is neither the creator nor an EDITOR. Message: Dashboard was not found.
FORBIDDENThe caller can modify the dashboard (is an EDITOR) but is not its creator. Message: You are not authorized.
UNAUTHENTICATEDThe request is missing or has invalid credentials. Message: You are not authenticated.
{
  "errors": [
    {
      "message": "You are not authorized.",
      "extensions": { "code": "FORBIDDEN" }
    }
  ]
}