HighLevel: Purchase number for location

← Phone system operations · Get started

Operation gohighlevel.purchase_number_for_location

Provider route: POST /phone-system/numbers/location/{locationId}/purchase. 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["phoneSystem"]["purchaseNumberForLocation"]>[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.phoneSystem.purchaseNumberForLocation(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.phone_system.purchase_number_for_location(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 Purchase number for location — request body — body

Referenced models: Purchase number for 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 Purchase number for location — response body

Referenced models: Purchase number for location — response body

Schemas

Purchase number for location — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	V3 purchase payload: purchased number, location, Twilio account id, and underLcAccount.
data (allOf 1)	Model	All variants apply	Expand Purchase number for location — response body — data id, location Id, number, under Lc Account
message	string	Required within parent	Human-readable success message.
status	string	Required within parent	Outcome indicator from the shared success helper. Known values: success
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	HTTP status echoed in the response body.
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Purchase number for location — response body — data id, location Id, number, under Lc Account

Purchase number for location — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
addressSid	string	Required within parent	addressSid twilio address id
bundleSid	string	Required within parent	bundleSid twilio bundle id
countryCode	string	Required within parent	country for which the phone numbers are being requested
fingerprintId	string	Required within parent	fingerprintId is request id which is unique for every purchase number request
locality	string	Required within parent	locality of the user in which number is being purchased
numberType	object	Required within parent	type of phone number to be purchased
paymentIntentId	string	Required within parent	stripe payment intent id
paymentMethodId	string	Required within parent	stripe registered payment method id
phoneNumber	string	Required within parent	phoneNumber to purchase
region	string	Required within parent	region of the user in which number is being purchased
skipLocationKYC	boolean	Required within parent	Skip location-level KYC verification if agency-level compliance has already been verified
stripeAccountId	string	Required within parent	stripe account id

Purchase number for location — response body — data id, location Id, number, under Lc Account

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Twilio account document identifier
locationId	string	Required within parent	Location that owns the Twilio / numbers account
number	string	Required within parent	E.164 phone number that was purchased (from the request body)
underLcAccount	boolean	Required within parent	Whether the account is managed under LC. Renamed from under_ghl_account in the legacy document.

Policy, approvals and errors

SDK function policy ID: gohighlevel.purchase_number_for_location. Catalog operation: purchase-number-for-location. 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.

Required provider scopes: ["phonenumbers.write"]

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

Official provider source