> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: startUpdateFlow()

## Article: startUpdateFlow()

## Article Link: https://dev.wix.com/docs/sdk/host-modules/workspace/apps/start-update-flow.md

## Article Content:

# startUpdateFlow()

Starts the flow to update an installed app to its latest released version. If the update requires new permissions, a consent modal opens. Otherwise, a loader modal opens and the app version updates.

![Permissions modal for updating](https://wixmp-833713b177cebf373f611808.wixmp.com/images/18e111fa8c932e57891ddff9778c25f8.png)

<blockquote class="important">

__Important:__ This method is only available in the editor.

</blockquote>

## Method declaration

```ts
(args: UpdateFlowRequest) => Promise<UpdateFlowResponse>
```

## Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `args` | [UpdateFlowRequest](#updateflowrequest) | Configuration options for updating the app. |

### UpdateFlowRequest

| Name | Type | Description |
| ---- | ---- | ----------- |
| `appId` | string | **Required.** The ID of the app to update. |

## Returns

```ts
Promise<UpdateFlowResponse>
```

A promise that resolves to an `UpdateFlowResponse` indicating the result of the update attempt.

### UpdateFlowResponse

| Name | Type | Description |
| ---- | ---- | ----------- |
| `status` | string | Status indicating that the update completed or explaining why it didn't. Possible values: <ul> <li>`SUCCESS`: Update completed successfully.</li> <li>`CANCELED`: The Wix user canceled the update process.</li> </ul> |
| `installedApps` | [InstalledApp[]](#installedapp) | Array of updated apps. Includes the target app and any apps that were also installed or updated because they're dependencies for it. The response includes this field only if `status` is `SUCCESS`. |

#### InstalledApp

| Name | Type | Description |
| ---- | ---- | ----------- |
| `appId` | string | The ID of the updated app. |
| `version` | string | The new version of the updated app. |

## Examples

### Update an app

```js
import { apps } from "@wix/workspace";

const myFunc = async () => {
	...
	const appId = <YOUR_APP_ID>;
	const result = await apps.startUpdateFlow({ appId });
	...
};
```


## Errors

This method may return the following [error codes](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-errors.md):

- `NOT_INSTALLED`: The app isn't installed. Apps must be installed before they can be updated.
- `ALREADY_UP_TO_DATE`: The app is already up to date.