> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qobra.co/llms.txt
> Use this file to discover all available pages before exploring further.

# update_dashboard

> Rename a dashboard, or change the note describing it.

Rename a dashboard, or change the note describing it.

Pass `name` and/or `description`; the one you omit is left as it stands, never
blanked out. Pass at least one of them — a call with neither has nothing to
update.

A rename to the values already stored writes nothing at all, so the same call
can safely be sent twice.

You need write access on the dashboard itself. A dashboard shared with you
read-only is refused with a message saying the share is read-only; pick one
you can edit from [`list_dashboards`](/mcp_documentation/tools/list_dashboards),
or create a new one with
[`create_dashboard`](/mcp_documentation/tools/create_dashboard). A dashboard
you cannot read at all is refused as not found.

Available only where the Qobra write tools beta is enabled. Every write to the
live environment is recorded in the audit trail as the `Qobra MCP` agent;
writes to a sandbox are not audited.

## Parameters

<Accordion title="Body" defaultOpen>
  <ParamField body="dashboard_id" type="string" required>
    Id of the dashboard to update — the id list\_dashboards returns, or the one
    create\_dashboard just returned. The dashboard names the environment this
    writes to, so there is no sandbox argument.
  </ParamField>

  <ParamField body="name" type="string">
    New display name for the dashboard. Omit to leave the current name as it
    is.
  </ParamField>

  <ParamField body="description" type="string">
    New free-text note about what the dashboard is for. Omit to leave the
    current description as it is.
  </ParamField>
</Accordion>

## Response

<Accordion title="Body" defaultOpen>
  <ResponseField name="dashboard" type="object">
    The dashboard as it now stands after the update.

    <Expandable title="object properties">
      <ResponseField name="id" type="string" />

      <ResponseField name="resource_url" type="string">
        Deep link to open this dashboard in the Qobra web app.
      </ResponseField>

      <ResponseField name="name" type="string" />

      <ResponseField name="description" type="string" />

      <ResponseField name="updated_at" type="string" />
    </Expandable>
  </ResponseField>
</Accordion>
