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

# Rename dashboard

> Changes the name of a dashboard and returns it. The name is the dashboard's, not a version's: no version is published, and a later edit from the chat that does not itself rename the dashboard keeps it. A session token may only rename its own.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/dashboards/{id}
openapi: 3.1.0
info:
  title: Sidenet API
  version: 1.0.0
  description: >-
    Sidenet HTTP endpoints exposed by the Sidenet Studio. All routes require an
    api key that can be generated through the studio in studio.sidenet.ai.
servers:
  - url: https://api.sidenet.ai
security:
  - bearerAuth: []
paths:
  /v1/dashboards/{id}:
    patch:
      tags:
        - Dashboards
      summary: Rename dashboard
      description: >-
        Changes the name of a dashboard and returns it. The name is the
        dashboard's, not a version's: no version is published, and a later edit
        from the chat that does not itself rename the dashboard keeps it. A
        session token may only rename its own.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                  description: The new name; surrounding whitespace is trimmed.
                  example: Weekly revenue
      responses:
        '200':
          description: The dashboard
          content:
            application/json:
              schema:
                type: object
                properties:
                  dashboard:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      description:
                        type: string
                        nullable: true
                      timezone:
                        type: string
                      workflow_id:
                        type: string
                        format: uuid
                      active_version:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                          number:
                            type: integer
                          created_at:
                            type: string
                            nullable: true
                      last_run_id:
                        type: string
                        nullable: true
                      last_refreshed_at:
                        type: string
                        nullable: true
                      last_refresh_status:
                        type: string
                        nullable: true
                      data_changed_at:
                        type: string
                        nullable: true
                        description: >-
                          When a tool write last touched the sources this
                          dashboard reads (an agent granted a role, checked a
                          guest in, …); null when never. The dashboard is STALE
                          when this is later than `last_refreshed_at` (or when
                          it was never refreshed): refresh it with `force:
                          true`. Never cleared — the comparison is what matters.
                          The event `dashboard.data_changed` on `GET /v1/events`
                          announces each new stamp.
                      refresh_schedule_id:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                      updated_at:
                        type: string
                  version:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                      number:
                        type: integer
                      created_at:
                        type: string
                        nullable: true
                  spec:
                    type: object
                    nullable: true
                    description: >-
                      The version's spec: `filters`, `sources`, `panels`
                      (layout: `span`, `height`, order; triggers: a stats
                      panel's `on_click`, a table's `row_key`, `cell_triggers`
                      (by column key: the cell value is a link), `on_row_click`,
                      `row_actions`), `views` (what a trigger opens: `kind`
                      table | stats | chart | … | form | thread | composite,
                      `title`, `presentation` drawer | modal, `context` keys; a
                      form view carries `tool`, `fields`, `initial`,
                      `submit_label`, `on_success`, `confirm` and `schema` — the
                      JSON Schema of its fields; a composite view carries
                      `blocks` — data blocks of any component kind, `text`
                      blocks, at most one `form` block with its `schema` — and
                      optional `tabs` / `default_tab`), `actions` (toolbar
                      buttons) and `tab_groups` (layout only: `{ id, tabs: [{
                      id, label }], default?, strip?: card | page | none }`; a
                      panel with `tab: { group, id }` shows only while that tab
                      is open). A trigger is `{ view, context }` or `{ tab: {
                      group, id } }` (select a tab instead of opening a view);
                      context values that are templates ("{{row.id}}",
                      "{{row}}", "{{stat.key}}", "{{stat.value}}",
                      "{{filters.<key>}}") are resolved by the page before it
                      calls the view.
                  filters:
                    type: object
                    properties:
                      schema:
                        type: array
                        items:
                          type: object
                        description: >-
                          The filter definitions (key, label, kind, options,
                          default).
                      values:
                        type: object
                        additionalProperties: true
                        description: >-
                          The values the page opens on (the last refresh's, else
                          the defaults).
                  data:
                    type: object
                    properties:
                      run_id:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                          - running
                          - succeeded
                          - failed
                      started_at:
                        type: string
                        format: date-time
                      refreshed_at:
                        type: string
                        format: date-time
                        nullable: true
                      filters:
                        type: object
                        additionalProperties: true
                        description: The raw filter values of this run.
                      panels:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            kind:
                              type: string
                              enum:
                                - stats
                                - chart
                                - table
                                - text
                            title:
                              type: string
                            span:
                              type: integer
                              description: Columns of 12.
                            height:
                              type: string
                              enum:
                                - sm
                                - md
                                - lg
                            component:
                              type: object
                              nullable: true
                              description: >-
                                The rendered payload, in the chat tool-call part
                                shape: `{ toolCallId, toolName: "showStats" |
                                "showChart" | "showTable", args, result }`.
                                `args` is what the SDK renders.
                            markdown:
                              type: string
                              nullable: true
                              description: Text panels.
                      error:
                        type: string
                        nullable: true
                    nullable: true
                    description: >-
                      The latest refresh, or null when the dashboard was never
                      refreshed.
        '400':
          description: '`name` is missing, empty or longer than 120 characters'
        '404':
          description: Not found
      security:
        - bearerAuth: []
        - sessionToken: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Organization API key, generated in studio.sidenet.ai. Backend only —
        never in a browser.
    sessionToken:
      type: http
      scheme: bearer
      description: >-
        Session token (`snat_…`) minted by POST /v1/token. Carries the
        organization and the end user; safe in a browser.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.