---
title: "Promote dashboard"
method: POST
path: "/api/v1/dashboards/{dashboardUuidOrSlug}/promote"
tags: ["Dashboards"]
---

# Promote dashboard

`POST /api/v1/dashboards/{dashboardUuidOrSlug}/promote`

Promote dashboard to its upstream project

## Path parameters

- `dashboardUuidOrSlug` string, required — A resource UUID or its URL slug. Resolve to a real UUID before using as a key.

## Query parameters

- `projectUuid` string, uuid — Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)

## Response `200`

Success

- ApiPromoteDashboardResponse
  - `results` DashboardDAO, required — From T, pick a set of properties whose keys are in the union K
    - `name` string, required
    - `description` string
    - `slug` string, required
    - `parameters` DashboardParameters — Construct a type with a set of properties K of type T
    - `filters` DashboardFilters, required
      - `tableCalculations` DashboardFilterRule[], required
        - `includeNull` boolean — For the `equals` operator on string fields, also match rows where the field is null (compiles to `field IN (...) OR field IS NULL`). Lets users combine null with selected values in a single "is" rule.
        - `values` AnyType[] — Values to filter by
          - unknown
        - `operator` 'isNull' | 'notNull' | 'equals' | 'notEquals' | 'startsWith' | 'endsWith' | 'include' | 'doesNotInclude' | 'lessThan' | 'lessThanOrEqual' | 'greaterThan' | 'greaterThanOrEqual' | 'inThePast' | 'notInThePast' | 'inTheNext' | 'inTheCurrent' | 'notInTheCurrent' | 'inBetween' | 'notInBetween' | 'inPeriodToDate', required
        - `id` string, required — Unique identifier for the filter
        - `target` DashboardFieldTarget, required
          - `fallbackType` 'string' | 'number' | 'timestamp' | 'date' | 'boolean'
          - `isSqlColumn` boolean
          - `tableName` string, required
          - `fieldId` string, required
        - `settings` unknown
        - `disabled` boolean — Whether this filter is disabled
        - `required` boolean — Whether this filter is required
        - `caseSensitive` boolean — Overrides the field/explore case-sensitivity for this rule only. Used by internal features like autocomplete search that must always match case-insensitively regardless of the field's configured setting.
        - `lockedTabUuids` string[] — Tab UUIDs where this filter is locked. When the active tab is in this list, viewers see the filter but cannot change it, and URL / embed filter overrides targeting the same field are ignored on that tab. Empty or omitted means the filter is not locked anywhere.
        - `requiredGroupId` string — Dashboard filters sharing a requiredGroupId form an "any-one required" group: the dashboard is locked until at least one member has a value.
        - `singleValue` boolean
        - `label` string
        - `tileTargets` DashboardTileTargets — Deliberately an index-signature literal, not `Record<string, ...>`. When TSOA first resolves `Record<string, DashboardTileTarget>` inside a mapped type (e.g. `Omit<DashboardFilterRule, 'id'>` in content-as-code types), it caches an EMPTY model under the shared `Record_string.DashboardTileTarget_` name, and request validation then strips every tileTargets entry from bodies — silently breaking dashboard filters on SQL chart tiles. The index-signature form resolves correctly in every context.
      - `metrics` DashboardFilterRule[], required
        - `includeNull` boolean — For the `equals` operator on string fields, also match rows where the field is null (compiles to `field IN (...) OR field IS NULL`). Lets users combine null with selected values in a single "is" rule.
        - `values` AnyType[] — Values to filter by
          - unknown
        - `operator` 'isNull' | 'notNull' | 'equals' | 'notEquals' | 'startsWith' | 'endsWith' | 'include' | 'doesNotInclude' | 'lessThan' | 'lessThanOrEqual' | 'greaterThan' | 'greaterThanOrEqual' | 'inThePast' | 'notInThePast' | 'inTheNext' | 'inTheCurrent' | 'notInTheCurrent' | 'inBetween' | 'notInBetween' | 'inPeriodToDate', required
        - `id` string, required — Unique identifier for the filter
        - `target` DashboardFieldTarget, required
          - `fallbackType` 'string' | 'number' | 'timestamp' | 'date' | 'boolean'
          - `isSqlColumn` boolean
          - `tableName` string, required
          - `fieldId` string, required
        - `settings` unknown
        - `disabled` boolean — Whether this filter is disabled
        - `required` boolean — Whether this filter is required
        - `caseSensitive` boolean — Overrides the field/explore case-sensitivity for this rule only. Used by internal features like autocomplete search that must always match case-insensitively regardless of the field's configured setting.
        - `lockedTabUuids` string[] — Tab UUIDs where this filter is locked. When the active tab is in this list, viewers see the filter but cannot change it, and URL / embed filter overrides targeting the same field are ignored on that tab. Empty or omitted means the filter is not locked anywhere.
        - `requiredGroupId` string — Dashboard filters sharing a requiredGroupId form an "any-one required" group: the dashboard is locked until at least one member has a value.
        - `singleValue` boolean
        - `label` string
        - `tileTargets` DashboardTileTargets — Deliberately an index-signature literal, not `Record<string, ...>`. When TSOA first resolves `Record<string, DashboardTileTarget>` inside a mapped type (e.g. `Omit<DashboardFilterRule, 'id'>` in content-as-code types), it caches an EMPTY model under the shared `Record_string.DashboardTileTarget_` name, and request validation then strips every tileTargets entry from bodies — silently breaking dashboard filters on SQL chart tiles. The index-signature form resolves correctly in every context.
      - `dimensions` DashboardFilterRule[], required
        - `includeNull` boolean — For the `equals` operator on string fields, also match rows where the field is null (compiles to `field IN (...) OR field IS NULL`). Lets users combine null with selected values in a single "is" rule.
        - `values` AnyType[] — Values to filter by
          - unknown
        - `operator` 'isNull' | 'notNull' | 'equals' | 'notEquals' | 'startsWith' | 'endsWith' | 'include' | 'doesNotInclude' | 'lessThan' | 'lessThanOrEqual' | 'greaterThan' | 'greaterThanOrEqual' | 'inThePast' | 'notInThePast' | 'inTheNext' | 'inTheCurrent' | 'notInTheCurrent' | 'inBetween' | 'notInBetween' | 'inPeriodToDate', required
        - `id` string, required — Unique identifier for the filter
        - `target` DashboardFieldTarget, required
          - `fallbackType` 'string' | 'number' | 'timestamp' | 'date' | 'boolean'
          - `isSqlColumn` boolean
          - `tableName` string, required
          - `fieldId` string, required
        - `settings` unknown
        - `disabled` boolean — Whether this filter is disabled
        - `required` boolean — Whether this filter is required
        - `caseSensitive` boolean — Overrides the field/explore case-sensitivity for this rule only. Used by internal features like autocomplete search that must always match case-insensitively regardless of the field's configured setting.
        - `lockedTabUuids` string[] — Tab UUIDs where this filter is locked. When the active tab is in this list, viewers see the filter but cannot change it, and URL / embed filter overrides targeting the same field are ignored on that tab. Empty or omitted means the filter is not locked anywhere.
        - `requiredGroupId` string — Dashboard filters sharing a requiredGroupId form an "any-one required" group: the dashboard is locked until at least one member has a value.
        - `singleValue` boolean
        - `label` string
        - `tileTargets` DashboardTileTargets — Deliberately an index-signature literal, not `Record<string, ...>`. When TSOA first resolves `Record<string, DashboardTileTarget>` inside a mapped type (e.g. `Omit<DashboardFilterRule, 'id'>` in content-as-code types), it caches an EMPTY model under the shared `Record_string.DashboardTileTarget_` name, and request validation then strips every tileTargets entry from bodies — silently breaking dashboard filters on SQL chart tiles. The index-signature form resolves correctly in every context.
    - `tabs` DashboardTab[], required
      - `hidden` boolean
      - `order` number, double, required
      - `name` string, required
      - `uuid` string, required
    - `config` DashboardConfig
      - `requiredFiltersNote` string — Editor-authored note shown to viewers while filter rules are unmet
      - `dateZoomConfig` DateZoomConfig
        - `tileTargets` RecordStringDateZoomTileTarget, required — Construct a type with a set of properties K of type T
        - `controls` DateZoomControl[], required
          - `hidden` boolean
          - `granularity` union, required
            - 'Second' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year'
            - string
          - `name` string, required
          - `uuid` string, required
      - `defaultDateZoomGranularity` union
        - 'Second' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year'
        - string
      - `dateZoomGranularities` union[]
        - union
          - 'Second' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year'
          - string
      - `parameterOrder` string[]
      - `pinnedParameters` string[]
      - `isAddFilterDisabled` boolean
      - `isDateZoomDisabled` boolean, required
    - `uuid` string, required
    - `organizationUuid` string, required
    - `projectUuid` string, required
    - `pinnedListUuid` string, nullable, required
    - `pinnedListOrder` number, double, nullable, required
    - `dashboardVersionId` number, double, required
    - `versionUuid` string, required
    - `verification` ContentVerificationInfo, required
      - `verifiedAt` string, date-time, required
      - `verifiedBy` object, required
        - `lastName` string, required
        - `firstName` string, required
        - `userUuid` string, required
    - `updatedAt` string, date-time, required
    - `tiles` DashboardTile[], required
      - union
        - DashboardChartTile — Make all properties in T required
          - `uuid` string, required
          - `type` 'saved_chart', required
          - `x` number, double, required
          - `y` number, double, required
          - `h` number, double, required
          - `w` number, double, required
          - `tabUuid` string, nullable
          - `properties` object, required
            - `chartSlug` string, nullable
            - `lastVersionChartKind` 'line' | 'horizontal_bar' | 'vertical_bar' | 'scatter' | 'area' | 'mixed' | 'pie' | 'table' | 'big_number' | 'funnel' | 'custom' | 'treemap' | 'gauge' | 'map' | 'sankey' | 'data_app_viz'
            - `chartName` string, nullable
            - `belongsToDashboard` boolean
            - `savedChartUuid` string, nullable, required
            - `hideTitle` boolean
            - `title` string
        - DashboardMarkdownTile — Make all properties in T required
          - `uuid` string, required
          - `type` 'markdown', required
          - `x` number, double, required
          - `y` number, double, required
          - `h` number, double, required
          - `w` number, double, required
          - `tabUuid` string, nullable
          - `properties` object, required
            - `hideFrame` boolean
            - `content` string, required
            - `title` string, required
        - DashboardLoomTile — Make all properties in T required
          - `uuid` string, required
          - `type` 'loom', required
          - `x` number, double, required
          - `y` number, double, required
          - `h` number, double, required
          - `w` number, double, required
          - `tabUuid` string, nullable
          - `properties` object, required
            - `url` string, required
            - `hideTitle` boolean
            - `title` string, required
        - DashboardSqlChartTile — Make all properties in T required
          - `uuid` string, required
          - `type` 'sql_chart', required
          - `x` number, double, required
          - `y` number, double, required
          - `h` number, double, required
          - `w` number, double, required
          - `tabUuid` string, nullable
          - `properties` object, required
            - `chartSlug` string, nullable
            - `hideTitle` boolean
            - `chartName` string, required
            - `savedSqlUuid` string, nullable, required
            - `title` string
        - DashboardHeadingTile — Make all properties in T required
          - `uuid` string, required
          - `type` 'heading', required
          - `x` number, double, required
          - `y` number, double, required
          - `h` number, double, required
          - `w` number, double, required
          - `tabUuid` string, nullable
          - `properties` object, required
            - `showDivider` boolean
            - `text` string, required
            - `title` unknown
        - DashboardDataAppTile — Make all properties in T required
          - `uuid` string, required
          - `type` 'data_app', required
          - `x` number, double, required
          - `y` number, double, required
          - `h` number, double, required
          - `w` number, double, required
          - `tabUuid` string, nullable
          - `properties` object, required
            - `appDeletedAt` string, nullable
            - `appUuid` string, required
            - `hideTitle` boolean
            - `title` string, required
    - `updatedByUser` UpdatedByUser
      - `userUuid` string, required
      - `firstName` string, required
      - `lastName` string, required
    - `spaceUuid` string, required
    - `spaceName` string, required
    - `views` number, double, required
    - `firstViewedAt` union, required
      - string
      - string, date-time
    - `colorPaletteUuid` string, nullable, required
    - `deletedAt` string, date-time
    - `deletedBy` object, nullable
      - `lastName` string, required
      - `firstName` string, required
      - `userUuid` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)