HighLevel: Create Custom Field Folder

← Custom fields operations · Get started

Operation gohighlevel.create_custom_field_folder

Provider route: POST /custom-fields/folder. 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["customFields"]["createCustomFieldFolder"]>[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.customFields.createCustomFieldFolder(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.custom_fields.create_custom_field_folder(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create Custom Field Folder — request body — body

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

Referenced models: Create Custom Field Folder — response body

Schemas

Create Custom Field Folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location Id
name	string	Required within parent	Field name
objectKey	string	Required within parent	The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

Create Custom Field Folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier of the object
locationId	string	Required within parent	Location Id
name	string	Required within parent	Field name
objectKey	string	Required within parent	The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_custom_field_folder. Catalog operation: create-custom-field-folder. 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