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

# IChangeInsightWidgetDescriptionPayload

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

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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

**Signature:**

```typescript
export interface IChangeInsightWidgetDescriptionPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [description](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangeinsightwidgetdescriptionpayload/index.md#ichangeinsightwidgetdescriptionpayloaddescription) | `readonly` | [IWidgetDescription](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iwidgetdescription/index.md) | **_(BETA)_** Description to use for the Insight widget. Contents of the provided description will be used as-is and will be used to replace the current description values. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangeinsightwidgetdescriptionpayload/index.md#ichangeinsightwidgetdescriptionpayloadref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** Reference to Insight Widget whose description to change. |

## Property details

### IChangeInsightWidgetDescriptionPayload.description

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Description to use for the Insight widget. Contents of the provided description will be used as-is and will be used to replace the current description values.

**Signature:**

```typescript
readonly description: IWidgetDescription;
```

### IChangeInsightWidgetDescriptionPayload.ref

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Reference to Insight Widget whose description to change.

**Signature:**

```typescript
readonly ref: ObjRef;
```