---
title: "PUT /api/dashboard/{id}"
method: PUT
path: "/api/dashboard/{id}"
tags: ["/api/dashboard"]
---

# PUT /api/dashboard/{id}

`PUT /api/dashboard/{id}`

Update a Dashboard, and optionally the `dashcards` and `tabs` of a Dashboard. The request body should be a JSON object with the same
  structure as the response from `GET /api/dashboard/:id`.

## Path parameters

- `id` integer, required

## Request body

- object
  - `archived` boolean, nullable
  - `cache_ttl` integer, nullable — value must be an integer greater than zero.
  - `caveats` string, nullable
  - `collection_id` integer, nullable — value must be an integer greater than zero.
  - `collection_position` integer, nullable — value must be an integer greater than zero.
  - `dashcards` object[], nullable — value must be seq of maps in which ids are unique
    - `col` integer, required — value must be an integer greater or equal to than zero.
    - `id` integer, required
    - `inline_parameters` string[], nullable
    - `parameter_mappings` MetabaseParametersSchemaParameterMapping[]
      - `card_id` integer — Valid Card ID
      - `dashcard` object
      - `parameter_id` string, required
      - `target` union, required
        - unknown
        - unknown[]
          - unknown
        - unknown[] — A :text-tag parameter :target applies to parameterized text cards in viz settings
          - unknown
        - MetabaseLibSchemaParameterTargetLegacyFieldRef — unresolved $ref
    - `row` integer, required — value must be an integer greater or equal to than zero.
    - `series` object[], nullable
    - `size_x` integer, required — value must be an integer greater than zero.
    - `size_y` integer, required — value must be an integer greater than zero.
  - `description` string, nullable
  - `embedding_params` object, nullable
  - `embedding_type` string, nullable
  - `enable_embedding` boolean, nullable
  - `name` string, nullable
  - `parameters` MetabaseParametersSchemaParameter[]
    - `default` unknown
    - `filteringParameters` MetabaseLibSchemaParameterId[], nullable
    - `id` string, required
    - `mappings` union
      - MetabaseParametersSchemaParameterMapping[]
        - `card_id` integer — Valid Card ID
        - `dashcard` object
        - `parameter_id` string, required
        - `target` union, required
          - unknown
          - unknown[]
            - unknown
          - unknown[] — A :text-tag parameter :target applies to parameterized text cards in viz settings
            - unknown
          - MetabaseLibSchemaParameterTargetLegacyFieldRef — unresolved $ref
      - MetabaseParametersSchemaParameterMapping[]
        - `card_id` integer — Valid Card ID
        - `dashcard` object
        - `parameter_id` string, required
        - `target` union, required
          - unknown
          - unknown[]
            - unknown
          - unknown[] — A :text-tag parameter :target applies to parameterized text cards in viz settings
            - unknown
          - MetabaseLibSchemaParameterTargetLegacyFieldRef — unresolved $ref
    - `name` string
    - `sectionId` string
    - `slug` string
    - `target` union
      - unknown
      - unknown[]
        - unknown
      - unknown[] — A :text-tag parameter :target applies to parameterized text cards in viz settings
        - unknown
      - MetabaseLibSchemaParameterTargetLegacyFieldRef — unresolved $ref
    - `temporal_units` MetabaseLibSchemaTemporalBucketingUnit[], nullable
    - `type` 'number' | 'text' | 'date' | 'boolean' | 'date/single' | 'id' | 'category' | 'location/city' | 'location/state' | 'location/zip_code' | 'location/country' | 'date/range' | 'date/month-year' | 'date/quarter-year' | 'date/relative' | 'date/all-options' | 'temporal-unit' | 'number/!=' | 'number/<=' | 'number/=' | 'number/>=' | 'number/between' | 'string/!=' | 'string/=' | 'string/contains' | 'string/does-not-contain' | 'string/ends-with' | 'string/starts-with' | 'boolean/=', required — Valid parameter :type
    - `values_query_type` 'none' | 'list' | 'search'
    - `values_source_config` MetabaseParametersSchemaValuesSourceConfig — Schema for valid source_options within a Parameter
      - `card_id` integer — Valid Card ID
      - `label_field` union
        - unknown
        - MetabaseLibSchemaParameterTargetLegacyFieldRef — unresolved $ref
      - `value_field` union
        - unknown
        - MetabaseLibSchemaParameterTargetLegacyFieldRef — unresolved $ref
      - `values` unknown
    - `values_source_type` 'static-list' | 'card'
  - `points_of_interest` string, nullable
  - `position` integer, nullable — value must be an integer greater than zero.
  - `show_in_getting_started` boolean, nullable
  - `tabs` object[], nullable — value must be seq of maps in which ids are unique
    - `id` integer, required — value must be an integer.
    - `name` string, required
  - `width` 'fixed' | 'full'

## Response `2XX`

Successful response

## Other responses

- `4XX` — Client error response
- `5XX` — Server error response

---

[API](https://skmtc.dev/metabase/apis/metabase-api.md) · [All operations](https://skmtc.dev/metabase/apis/metabase-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/metabase/metabase-api/revisions/e879e0319b12/schema)