> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IChangeDashboardDefinitionPayload

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/commands/dashboard.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Payload of the [IChangeDashboardDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangedashboarddefinition/index.md) command.

**Signature:**

```typescript
export interface IChangeDashboardDefinitionPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangedashboarddefinitionpayload/index.md#ichangedashboarddefinitionpayloaddashboard) | `readonly` | [IDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md) | **_(ALPHA)_** Dashboard definition to apply to the current dashboard. |
| [insights?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangedashboarddefinitionpayload/index.md#ichangedashboarddefinitionpayloadinsights) | `readonly` | ReadonlyArray<[IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)> | **_(ALPHA)_** _(Optional)_ Insights used in the dashboard definition. |
| [references?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangedashboarddefinitionpayload/index.md#ichangedashboarddefinitionpayloadreferences) | `readonly` | Partial<[IDashboardReferences](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardreferences/index.md)> | **_(ALPHA)_** _(Optional)_ Referenced objects used in the dashboard definition. |

## Property details

### IChangeDashboardDefinitionPayload.dashboard

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Dashboard definition to apply to the current dashboard.

**Signature:**

```typescript
readonly dashboard: IDashboard;
```

### IChangeDashboardDefinitionPayload.insights

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

> Warning: This API is now obsolete.
> 
> Use references.insights instead.
> 

Insights used in the dashboard definition.

**Signature:**

```typescript
readonly insights?: ReadonlyArray<IInsight>;
```

### IChangeDashboardDefinitionPayload.references

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Referenced objects used in the dashboard definition.

**Signature:**

```typescript
readonly references?: Partial<IDashboardReferences>;
```