HighLevel: Create Custom Object

← Objects operations · Get started

Operation gohighlevel.create_custom_object_schema

Provider route: POST /objects/. 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["objects"]["createCustomObjectSchema"]>[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.objects.createCustomObjectSchema(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.objects.create_custom_object_schema(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 Object — request body — body

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

Referenced models: Create Custom Object — response body

Schemas

Create Custom Object — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	Pet Object`s description
key	string	Required within parent	key that would be used to refer the Custom Object internally (lowercase + underscore_separated). 'custom_objects.' would be added as prefix by default
labels	JSON	Required within parent	This is what your custom object will be called. These labels will be used to display your custom object on the UI
labels (allOf 1)	Model	All variants apply	Expand Create Custom Object — request body — body labels plural, singular
locationId	string	Required within parent	Location Id
primaryDisplayPropertyDetails	JSON	Required within parent	Primary property which will be displayed on the record page
primaryDisplayPropertyDetails (allOf 1)	Model	All variants apply	Expand Create Custom Object — request body — body primary Display Property Details data Type, key, name

Referenced models: Create Custom Object — request body — body primary Display Property Details data Type, key, name, Create Custom Object — request body — body labels plural, singular

Create Custom Object — response body

Field	Type	Presence	Description and constraints
$	object	Root
object	Model	Optional	Expand Create Custom Object — response body — object

Referenced models: Create Custom Object — response body — object

Create Custom Object — request body — body primary Display Property Details data Type, key, name

Field	Type	Presence	Description and constraints
$	object	Root
dataType	string	Required within parent	Primary property data Type (it can either be TEXT or NUMERICAL type)
key	string	Required within parent	key that would be used to refer the custom field internally (lowercase + underscore_separated). 'custom_objects.{{objectKey}}' would be added as prefix by default is not passed
name	string	Required within parent	Name of the Primary property name which will be displayed on the record page

Create Custom Object — request body — body labels plural, singular

Field	Type	Presence	Description and constraints
$	object	Root
plural	string	Required within parent	Plural name of the custom object
singular	string	Required within parent	Singular name of the custom object

Create Custom Object — response body — object

Field	Type	Presence	Description and constraints
$	object	Root
dateAdded	string	Required within parent	Date and time when the object was added Format: date-time
dateUpdated	string	Required within parent	Date and time when the object was last updated Format: date-time
description	string	Optional	Custom / Standard Object Descriptions for example , Pet Object`s description
id	string	Required within parent	id of the custom / standard object schema
key	string	Required within parent	key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default
labels	JSON	Required within parent	This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI
labels (allOf 1)	Model	All variants apply	Expand Create Custom Object — request body — body labels plural, singular
locationId	string	Required within parent	location's id
primaryDisplayProperty	string	Required within parent	Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects
standard	boolean	Required within parent	false in case of custom objects and true in case of standard objects like contacts and opportunities
type	object	Optional	Object`s Type

Referenced models: Create Custom Object — request body — body labels plural, singular

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_custom_object_schema. Catalog operation: create-custom-object-schema. 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: ["objects/schema.write"]

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

Official provider source