HighLevel: Put Sub-Account (Formerly Location)

← Locations operations · Get started

Operation gohighlevel.put_location

Provider route: PUT /locations/{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["locations"]["putLocation"]>[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.locations.putLocation(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.locations.put_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 Put Sub-Account (Formerly Location) — request body — body

Referenced models: Put Sub-Account (Formerly 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 Put Sub-Account (Formerly Location) — response body

Referenced models: Put Sub-Account (Formerly Location) — response body

Schemas

Put Sub-Account (Formerly Location) — response body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address of the business for which sub-account is created
city	string	Optional	The city where the business is located for which sub-account is created
companyId	string	Optional	Company/Agency Id
country	string	Optional	The country in which the business is present for which sub-account is created Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, GB, UA, AE, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
domain	string	Optional
email	string	Optional	The email for the sub-account/location
id	string	Optional	Location Id
name	string	Optional	The name for the sub-account/location
phone	string	Optional	The phone number of the business for which sub-account is created
postalCode	string	Optional	The postal code of the business for which sub-account is created
settings	JSON	Optional	The default settings for location
settings (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location settings
social	JSON	Optional	The social media links for location
social (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional	The state in which the business operates for which sub-account is created
timezone	string	Optional	The timezone of the business for which sub-account is created
website	string	Optional	The website of the business for which sub-account is created

Referenced models: Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social

Put Sub-Account (Formerly Location) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address of the business for which sub-account is created
city	string	Optional	The city where the business is located for which sub-account is created
companyId	string	Required within parent	Company/Agency Id
country	string	Optional	The country in which the business is present for which sub-account is created One of: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, GB, UA, AE, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
mailgun	JSON	Optional	The mailgun credentials for location
mailgun (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain
name	string	Optional	The name for the sub-account/location
phone	string	Optional	The phone number of the business for which sub-account is created
postalCode	string	Optional	The postal code of the business for which sub-account is created
prospectInfo	JSON	Optional
prospectInfo (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name
settings	JSON	Optional	The default settings for location
settings (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location settings
snapshot	JSON	Optional	The snapshot to be updated in the location.
snapshot (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body snapshot id, override
social	JSON	Optional	The social media links for location
social (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional	The state in which the business operates for which sub-account is created
timezone	string	Optional	The timezone of the business for which sub-account is created
twilio	JSON	Optional	(DEPRECATED) The twilio credentials for location
twilio (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid
website	string	Optional	The website of the business for which sub-account is created

Referenced models: Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain, Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social, Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name, Put Sub-Account (Formerly Location) — request body — body snapshot id, override, Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid

Get Sub-Account (Formerly Location) — response body — location settings

Field	Type	Presence	Description and constraints
$	object	Root
allowDuplicateContact	boolean	Optional
allowDuplicateOpportunity	boolean	Optional
allowFacebookNameMerge	boolean	Optional
disableContactTimezone	boolean	Optional

Get Sub-Account (Formerly Location) — response body — location social

Field	Type	Presence	Description and constraints
$	object	Root
blogRss	string	Optional	Instagram URL
facebookUrl	string	Optional	Facebook URL
foursquare	string	Optional	Foursquare URL
googlePlacesId	string	Optional	Google Business Places ID
googlePlus	string	Optional	Googleplus URL
instagram	string	Optional	Instagram URL
linkedIn	string	Optional	LinkedIn URL
pinterest	string	Optional	Instagram URL
twitter	string	Optional	Twitter URL
yelp	string	Optional	Yelp URL
youtube	string	Optional	Instagram URL

Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain

Field	Type	Presence	Description and constraints
$	object	Root
apiKey	string	Required within parent	API key provided by Mailgun
domain	string	Required within parent	Domain connected with Mailgun

Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	Email of the prospect
firstName	string	Required within parent	First name of the prospect
lastName	string	Required within parent	Last name of the prospect

Put Sub-Account (Formerly Location) — request body — body snapshot id, override

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Snaptshot ID
override	boolean	Optional	If you want override all conflicted assets then pass true. Default value is false. Default: false

Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid

Field	Type	Presence	Description and constraints
$	object	Root
authToken	string	Required within parent	Auth token provided by Twilio
sid	string	Required within parent	SID provided by Twilio

Policy, approvals and errors

SDK function policy ID: gohighlevel.put_location. Catalog operation: put-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: ["locations.write"]

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

Official provider source