HighLevel: Uninstall an application

← Marketplace operations · Get started

Operation gohighlevel.uninstall_application

Provider route: DELETE /marketplace/app/{appId}/installations. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["marketplace"]["uninstallApplication"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.marketplace.uninstallApplication(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.marketplace.uninstall_application(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.appId	string	Required within parent
body	Model	Required within parent	Expand Uninstall an application — request body — body

Referenced models: Uninstall an application — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Uninstall an application — response body

Referenced models: Uninstall an application — response body

Schemas

Uninstall an application — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
companyId	string	Optional	The company id from which the application is to be uninstalled. If you pass agency token, then companyId is required. It will uninstall application from agency as well as all sub-accounts.
locationId	string	Optional	The location id from which the application is to be uninstalled. If you pass location token, then locationId is required. It will uninstall application from that location only.
reason	string	Optional	The reason for uninstalling the application. Reason is required if you are uninstalling the application as a developer.

Uninstall an application — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	The status of the uninstallation of the application

Policy, approvals and errors

SDK function policy ID: gohighlevel.uninstall_application. Catalog operation: uninstall-application. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Refused by default. This operation leaves the caller holding a credential (Uninstalling the application revokes the credential the connection holds, which destroys the connection Alter holds; Alter’s own disconnect is the supported path.), so Alter refuses it on every connection with credential_minting_refused unless an organization admin allows it: a credential_minting rule naming provider gohighlevel and operation gohighlevel.uninstall_application (or uninstall-application). See Allow an operation that hands over a credential.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["oauth.write"]

Pinned headers: {"Version": "v3"}

Official provider source