> ## Documentation Index > Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt > Use this file to discover all available pages before exploring further. # Update a dashboard > Every field is optional, and a field left out keeps the stored value: send only what you change, so a rename someone made since you read the dashboard is not undone. `name` and `period_rule` replace theirs; `permission_groups` replaces the groups (`{}` clears them); `module` and `widgets` together replace the definition. Then asks for a refresh of every widget, a rename included, and returns at once; every widget is `pending` until it lands. `refresh_started` is false when the change was stored but the refresh could not start. `restore_definition_id` (an id from `GET /dashboards//definitions`) instead makes that earlier definition the one in use, stores no new one, and refreshes every widget; sent with `module` or `widgets` it is a 422, and so is an id that is not this dashboard's. Sending `module` or `widgets`, `restore_definition_id`, or other permission groups, is building: admins only. A rename or a period change: the creator or an admin. Otherwise 403. The old definition's data shows as `stale` until the refresh replaces it. `expected_definition_id`: the `definition_id` your `GET` returned (a UUID). Send it on every `PUT`: when the dashboard uses another definition now, the `PUT` is a 409 `dashboard_update_conflict` and nothing is stored. Without it, only a change made while this `PUT` was saving is a 409; a change made between your `GET` and the `PUT` is overwritten, and a `module` or `widgets` sent alone is paired with the other half as it is when the `PUT` arrives. After a 409, `GET` the dashboard and apply your change to what it has now. ## OpenAPI ````yaml https://api.neoagent.io/public-api/openapi.json put /public-api/dashboards/{dashboard_id} openapi: 3.1.0 info: description: >- Neo's public contract for the dashboard ChatAgent, partner integrations, and MSP automation. Every response is wrapped in a `{data, meta}` envelope; errors use `{error: {code, message, details?}, meta: {request_id}}`. Authenticate with a `Bearer neo_sk__` API key (service account) or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user feedback links) take a `signature` query parameter instead. title: Neo Public API version: 1.0.0 servers: - url: https://api.neoagent.io security: [] tags: - description: Service metadata — health, OpenAPI. name: Meta - description: Agents and workflows — read, version history, delete, stats. name: Agents - description: Agent/workflow execution history, sub-resources, retry/cancel. name: Executions - description: >- Every tool call the tenant's agents made in the last 30 days, within the caller's workflow access. name: Audit Log - description: PSA webhook events and their workflow-match results. name: Callbacks - description: Technician-in-the-loop approval requests. name: TIL requests - description: RMM script executions triggered by agents. name: RMM scripts - description: Dispatch-agent field-update decisions. name: Dispatch - description: The authenticated tenant. name: Tenant - description: Agent-builder schema catalogs (raw JSON payloads). name: Schemas - description: Escalate to the Neo team (HubSpot ticket). name: Escalation - description: Tenant settings. name: Settings - description: Tenant API-key management (dashboard JWT only). name: API keys - description: End-user feedback links (signed-URL auth). name: Feedback - description: End-client companies (CRUD + bulk-update). name: End companies - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack). name: Channels - description: PSA/RMM/M365 integration status and connection management. name: Integrations - description: Technician roster (controls TIL routing and paging). name: Technicians - description: Future runs queued for TRIGGERED agents. name: Scheduled work - description: Subscription state and customer-facing credit usage (no provider $). name: Billing - description: Inbox messages and announcements. name: Inbox & Comms - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog. name: Skills paths: /public-api/dashboards/{dashboard_id}: put: tags: - Dashboards summary: Update a dashboard description: >- Every field is optional, and a field left out keeps the stored value: send only what you change, so a rename someone made since you read the dashboard is not undone. `name` and `period_rule` replace theirs; `permission_groups` replaces the groups (`{}` clears them); `module` and `widgets` together replace the definition. Then asks for a refresh of every widget, a rename included, and returns at once; every widget is `pending` until it lands. `refresh_started` is false when the change was stored but the refresh could not start. `restore_definition_id` (an id from `GET /dashboards//definitions`) instead makes that earlier definition the one in use, stores no new one, and refreshes every widget; sent with `module` or `widgets` it is a 422, and so is an id that is not this dashboard's. Sending `module` or `widgets`, `restore_definition_id`, or other permission groups, is building: admins only. A rename or a period change: the creator or an admin. Otherwise 403. The old definition's data shows as `stale` until the refresh replaces it. `expected_definition_id`: the `definition_id` your `GET` returned (a UUID). Send it on every `PUT`: when the dashboard uses another definition now, the `PUT` is a 409 `dashboard_update_conflict` and nothing is stored. Without it, only a change made while this `PUT` was saving is a 409; a change made between your `GET` and the `PUT` is overwritten, and a `module` or `widgets` sent alone is paired with the other half as it is when the `PUT` arrives. After a 409, `GET` the dashboard and apply your change to what it has now. operationId: public_api.dashboards_update_put parameters: - in: path name: dashboard_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDashboardRequest' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/PublicDashboardCard' meta: $ref: '#/components/schemas/SuccessMeta' required: - data - meta type: object description: Success. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Bad request — malformed input. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Unauthenticated — missing or invalid credentials. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Forbidden — authenticated but not allowed. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Conflict — the resource is in a state that blocks this operation. '422': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Request validation failed. '429': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Rate limited — see Retry-After. '500': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Internal server error. security: - bearerAuth: [] components: schemas: UpdateDashboardRequest: description: >- Every field left out keeps the stored value. `module` and `widgets` together replace the definition. `restore_definition_id` instead makes an earlier definition the one in use. `permission_groups` `{}` clears the groups. properties: expected_definition_id: anyOf: - format: uuid type: string - type: 'null' default: null description: >- The `definition_id` you read with `GET`. When the dashboard uses another definition now, the update is a 409 and nothing is stored. title: Expected Definition Id module: anyOf: - type: string - type: 'null' default: null title: Module name: anyOf: - maxLength: 120 minLength: 1 type: string - type: 'null' default: null title: Name period_rule: anyOf: - $ref: '#/components/schemas/PeriodRuleRequest' - type: 'null' default: null permission_groups: anyOf: - additionalProperties: items: type: string type: array type: object - type: 'null' default: null title: Permission Groups restore_definition_id: anyOf: - format: uuid type: string - type: 'null' default: null description: >- An id from `GET /dashboards//definitions`: its module and widgets become the dashboard's again. Not with `module` or `widgets`. title: Restore Definition Id widgets: anyOf: - items: $ref: '#/components/schemas/PublicWidget' type: array - type: 'null' default: null title: Widgets title: UpdateDashboardRequest type: object PublicDashboardCard: description: >- What a write answers: enough for the chat to open the dashboard beside it. properties: dashboard_id: title: Dashboard Id type: string definition_id: title: Definition Id type: string name: title: Name type: string refresh_started: title: Refresh Started type: boolean widget_count: title: Widget Count type: integer widget_ids: items: type: string title: Widget Ids type: array required: - dashboard_id - name - definition_id - widget_ids - widget_count - refresh_started title: PublicDashboardCard type: object SuccessMeta: properties: pagination: $ref: '#/components/schemas/Pagination' request_id: format: uuid type: string timings_ms: additionalProperties: type: number type: object warnings: description: >- Non-fatal warnings about the created/updated resource (e.g. an unhealthy PSA callback). items: type: string type: array required: - request_id - timings_ms type: object ErrorEnvelope: properties: error: properties: code: description: Stable machine-readable error code. type: string details: additionalProperties: true type: object message: type: string required: - code - message type: object meta: properties: request_id: format: uuid type: - string - 'null' type: object required: - error - meta type: object PeriodRuleRequest: properties: days: anyOf: - maximum: 366 minimum: 1 type: integer - type: 'null' default: null description: 'For LAST_N_DAYS: how many days back from now.' title: Days kind: description: The data window every widget reads, resolved at each refresh. enum: - LAST_N_DAYS - PREVIOUS_CALENDAR_WEEK - MONTH_TO_DATE title: Kind type: string timezone: description: >- IANA name, e.g. Europe/London; calendar weeks and months start at local midnight there. title: Timezone type: string required: - kind - timezone title: PeriodRuleRequest type: object PublicWidget: description: >- One widget of a dashboard: the preset component the page draws it with, where it sits on the grid, and the widgets whose data it reads. properties: component: description: >- The preset component the page draws the data with; the data has its shape. enum: - stat_group - bar_chart - line_chart - pie_chart - radial - table - progress_list - alert - text - grouped_list - heatmap - combo_chart - key_value - timeline - status_grid - scatter_chart - radar_chart - funnel_chart title: Component type: string data_schema: additionalProperties: true description: >- Optional JSON Schema (Draft 2020-12) pinning more of what widget_ returns, on top of the component's own shape. title: Data Schema type: object id: description: Lowercase id; the module defines widget_(ctx). pattern: ^[a-z][a-z0-9_]{0,39}$ title: Id type: string inputs: description: >- Widgets whose data this one reads as ctx.inputs (a summary widget); each must be listed before it. items: type: string title: Inputs type: array layout: $ref: '#/components/schemas/PublicWidgetLayout' title: maxLength: 120 minLength: 1 title: Title type: string required: - id - title - component - layout title: PublicWidget type: object Pagination: properties: has_more: type: boolean next_cursor: type: - string - 'null' required: - next_cursor - has_more type: object PublicWidgetLayout: description: The widget's cell on the 12-column grid. `y` and `h` are in rows. properties: h: maximum: 12 minimum: 1 title: H type: integer w: maximum: 12 minimum: 1 title: W type: integer x: exclusiveMaximum: 12 minimum: 0 title: X type: integer 'y': minimum: 0 title: 'Y' type: integer required: - x - 'y' - w - h title: PublicWidgetLayout type: object securitySchemes: bearerAuth: description: >- `Authorization: Bearer ` where `` is either a `neo_sk__` API key (service account) or a Microsoft Entra ID access token (dashboard user). scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.