> 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 # BulkUninstallApp # Package: appInstallation # Namespace: AppsInstallerService # Method link: https://dev.wix.com/docs/api-reference/business-management/app-installation/app-installation/bulk-uninstall-app.md ## Introduction
__Note:__ Only logged-in [Wix users](https://dev.wix.com/docs/rest/articles/get-started/about-identities.md#wix-user) or [API key admins](https://dev.wix.com/docs/rest/articles/get-started/about-identities.md#api-key-admin) can use this API.
Uninstalls apps from a tenant. This removes the instances of the specified apps from the tenant. --- ## REST API ### Schema ``` Method: bulkUninstallApp Description:
__Note:__ Only logged-in [Wix users](https://dev.wix.com/docs/rest/articles/get-started/about-identities.md#wix-user) or [API key admins](https://dev.wix.com/docs/rest/articles/get-started/about-identities.md#api-key-admin) can use this API.
Uninstalls apps from a tenant. This removes the instances of the specified apps from the tenant. URL: https://www.wixapis.com/v1/bulk/app-instance/uninstall Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: appDefIds Method parameters: param name: appDefIds | type: array | description: List of apps to be uninstalled. | required: true param name: tenant | type: Tenant - name: id | type: string | description: Tenant GUID. For a site, this is the [site GUID](https://dev.wix.com/docs/rest/account-level/sites/sites/introduction.md). For an account this is the [account GUID](https://dev.wix.com/docs/rest/account-level/user-management/accounts/accounts/about-accounts.md). - name: tenantType | type: TenantType | description: Tenant type. This can be a Wix site or account. - enum: SITE, ACCOUNT Return type: BulkUninstallAppResponse - name: results | type: array | description: Information and metadata about the uninstalled apps. - name: itemMetadata | type: ItemMetadata | description: Metadata about the uninstalled app instance. - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: appInstance | type: AppInstance | description: Details of the uninstalled app instance. - name: id | type: string | description: App instance GUID. - name: appDefId | type: string | description: GUID of the app to install. - name: version | type: string | description: Version of the app to install. If you don't specify a version, the latest version of the app will be installed. Don't specify a version unless you want to install an older version of the app. - name: enabled | type: boolean | description: Whether the app instance is enabled. - name: appToken | type: string | description: A signed access token of the Wix user and the app instance. - name: installedDate | type: string | description: Date and time the app instance was installed. - name: updatedDate | type: string | description: Date and time the app instance was last updated. - name: bulkActionMetadata | type: BulkActionMetadata | description: Metadata about the bulk uninstallation. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### BulkUninstallApp ```curl ~~~cURL curl --request POST \ https://www.wixapis.com/apps-installer-service/v1/bulk/app-instance/uninstall \ -H 'Content-Type: application/json' \ -H 'Authorization: ' -d '{ "tenant": { "tenantType": "SITE", "id": "573cf0bc-a4d0-434c-ab5f-c8babcfa4a5b" }, "appDefIds": [ "96186799-d99a-4b96-adf9-7cb2c1cf1e79" ] }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.appInstallation.AppsInstallerService.bulkUninstallApp(options) Description:
__Note:__ Only logged-in [Wix users](https://dev.wix.com/docs/rest/articles/get-started/about-identities.md#wix-user) or [API key admins](https://dev.wix.com/docs/rest/articles/get-started/about-identities.md#api-key-admin) can use this API.
Uninstalls apps from a tenant. This removes the instances of the specified apps from the tenant. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: options.appDefIds, options Method parameters: param name: options | type: BulkUninstallAppOptions none | required: true - name: tenant | type: Tenant | description: Tenant details. - name: _id | type: string | description: Tenant GUID. For a site, this is the [site GUID](https://dev.wix.com/docs/rest/account-level/sites/sites/introduction.md). For an account this is the [account GUID](https://dev.wix.com/docs/rest/account-level/user-management/accounts/accounts/about-accounts.md). - name: tenantType | type: TenantType | description: Tenant type. This can be a Wix site or account. - enum: SITE, ACCOUNT - name: appDefIds | type: array | description: List of apps to be uninstalled. | required: true Return type: PROMISE - name: results | type: array | description: Information and metadata about the uninstalled apps. - name: itemMetadata | type: ItemMetadata | description: Metadata about the uninstalled app instance. - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: appInstance | type: AppInstance | description: Details of the uninstalled app instance. - name: _id | type: string | description: App instance GUID. - name: appDefId | type: string | description: GUID of the app to install. - name: version | type: string | description: Version of the app to install. If you don't specify a version, the latest version of the app will be installed. Don't specify a version unless you want to install an older version of the app. - name: enabled | type: boolean | description: Whether the app instance is enabled. - name: appToken | type: string | description: A signed access token of the Wix user and the app instance. - name: installedDate | type: Date | description: Date and time the app instance was installed. - name: _updatedDate | type: Date | description: Date and time the app instance was last updated. - name: bulkActionMetadata | type: BulkActionMetadata | description: Metadata about the bulk uninstallation. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### bulkUninstallApp ```javascript import { appsInstaller } from '@wix/apps-installer'; async function bulkUninstallApp(options) { const response = await appsInstaller.bulkUninstallApp(options); }; ``` ### bulkUninstallApp (with elevated permissions) ```javascript import { appsInstaller } from '@wix/apps-installer'; import { auth } from '@wix/essentials'; async function myBulkUninstallAppMethod(options) { const elevatedBulkUninstallApp = auth.elevate(appsInstaller.bulkUninstallApp); const response = await elevatedBulkUninstallApp(options); } ``` ### bulkUninstallApp (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { appsInstaller } from '@wix/apps-installer'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { appsInstaller }, // Include the auth strategy and host as relevant }); async function bulkUninstallApp(options) { const response = await myWixClient.appsInstaller.bulkUninstallApp(options); }; ``` ---