HighLevel: Create Custom Field — locations create Custom Field

← Locations operations · Get started

Operation gohighlevel.locations_create_custom_field

Provider route: POST /locations/{locationId}/customFields. 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"]["createCustomField"]>[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.createCustomField(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.create_custom_field(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 Create Custom Field — locations create Custom Field — request body — body

Referenced models: Create Custom Field — locations create Custom Field — 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 Get Custom Field — response body

Referenced models: Get Custom Field — response body

Schemas

Create Custom Field — locations create Custom Field — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedFormat	array	Optional
acceptedFormat[]	string	Each item
dataType	string	Required within parent
isMultipleFile	boolean	Optional
maxNumberOfFiles	number	Optional
model	string	Optional	Model of the custom field you want to create One of: contact, opportunity
name	string	Required within parent
placeholder	string	Optional
position	number	Optional	Default: 0
textBoxListOptions	array	Optional
textBoxListOptions[]	JSON	Each item
textBoxListOptions[] (anyOf 1)	Model	Alternative	Expand Update Custom Field — request body — body text Box List Options item label, prefill Value
textBoxListOptions[] (anyOf 2)	Model	Alternative	Expand Update Custom Field — request body — body text Box List Options item label, prefill Value

Referenced models: Update Custom Field — request body — body text Box List Options item label, prefill Value

Get Custom Field — response body

Field	Type	Presence	Description and constraints
$	object	Root
customField	Model	Optional	Expand Get Custom Field — response body — custom Field

Referenced models: Get Custom Field — response body — custom Field

Update Custom Field — request body — body text Box List Options item label, prefill Value

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Optional
prefillValue	string	Optional

Get Custom Field — response body — custom Field

Field	Type	Presence	Description and constraints
$	object	Root
dataType	string	Optional
fieldKey	string	Optional
id	string	Optional
isAllowedCustomOption	boolean	Optional
isMultiFileAllowed	boolean	Optional
locationId	string	Optional
maxFileLimit	JSON	Optional
maxFileLimit (anyOf 1)	number	Alternative
maxFileLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
model	string	Optional	Model of the custom field Known values: contact, opportunity
name	string	Optional
picklistImageOptions	array	Optional
picklistImageOptions[]	string	Each item
picklistOptions	array	Optional
picklistOptions[]	string	Each item
placeholder	string	Optional
position	JSON	Optional
position (anyOf 1)	number	Alternative
position (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.locations_create_custom_field. Catalog operation: locations.create-custom-field. 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/customFields.write"]

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

Official provider source