HighLevel: Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location Deprecated

← Saas operations · Get started

Operation gohighlevel.enable_saas_location_deprecated

Provider route: POST /saas-api/public-api/enable-saas/{locationId}. 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["saas"]["enableSaasLocationDeprecated"]>[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.saas.enableSaasLocationDeprecated(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.saas.enable_saas_location_deprecated(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.locationId	string	Required within parent
body	Model	Required within parent	Expand Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location — request body — body

Referenced models: Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location — 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 Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location Deprecated — response body

Referenced models: Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location Deprecated — response body

Schemas

Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
companyId	string	Required within parent
contactId	string	Optional	Agency subaccount used for payment provider integration(Required Only for SaaS V2)
description	string	Optional	Description
email	string	Optional	Email of the stripe customer(Required only for SaaS V1)
isSaaSV2	boolean	Required within parent	Denotes if it is a saas v2 or v1 sub-account
name	string	Optional	Name of the stripe customer(Required only for SaaS V1)
priceId	string	Optional	Required only while pre-configuring saas subscription
providerLocationId	string	Optional	Agency Subaccount ID
saasPlanId	string	Optional	Required only while pre-configuring saas subscription
stripeAccountId	string	Optional	Stripe account id(Required only for SaaS V1)
stripeCustomerId	string	Optional	Stripe customer id if exists(Required only for SaaS V1)

Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location Deprecated — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	object	Required within parent	Response data from the enable SaaS operation

Policy, approvals and errors

SDK function policy ID: gohighlevel.enable_saas_location_deprecated. Catalog operation: enable-saas-location-deprecated. 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.

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.

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

Official provider source