HubSpot: Update the schema of a specified custom object

← Schemas operations · Get started

Operation hubspot.schemas_update_schema

Provider route: PATCH /crm-object-schemas/2026-09/schemas/{objectType}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["schemas"]["updateSchema"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.schemas.updateSchema(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.schemas.update_schema(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.objectType	string	Required within parent
body	Model	Required within parent	Expand Update the schema of a specified custom object — request body — body

Referenced models: Update the schema of a specified 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 Update the schema of a specified custom object — response body

Referenced models: Update the schema of a specified custom object — response body

Schemas

Update the schema of a specified custom object — response body

Field	Type	Presence	Description and constraints
$	object	Root
allowsSensitiveProperties	boolean	Required within parent	Indicates whether the object type allows properties that contain sensitive data.
archived	boolean	Required within parent	Indicates whether the object type is archived.
createdAt	string	Optional	When the object type was created. Format: date-time
description	string	Optional	A description of the object type.
fullyQualifiedName	string	Required within parent	An assigned unique ID for the object, including portal ID and object name.
id	string	Required within parent	A unique ID for this object type. Will be defined as {meta-type}-{unique ID}.
labels	Model	Required within parent	Expand Create a new custom object schema — response body — labels
name	string	Required within parent	A unique name for this object. For internal use only.
objectTypeId	string	Required within parent	A unique identifier for the object type.
portalId	JSON	Optional
portalId (anyOf 1)	integer	Alternative	The ID of the account that this object type is specific to. Format: int32
portalId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
primaryDisplayProperty	string	Optional	The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
requiredProperties	array	Required within parent	The names of properties that should be **required** when creating an object of this type.
requiredProperties[]	string	Each item
searchableProperties	array	Required within parent	Names of properties that will be indexed for this object type in by HubSpot's product search.
searchableProperties[]	string	Each item
secondaryDisplayProperties	array	Required within parent	The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
secondaryDisplayProperties[]	string	Each item
updatedAt	string	Optional	When the object type was last updated. Format: date-time

Referenced models: Create a new custom object schema — response body — labels

Update the schema of a specified custom object — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
allowsSensitiveProperties	boolean	Optional	Determines if the object type can include properties that are marked as sensitive.
clearDescription	boolean	Required within parent	Indicates whether the description of the object type should be cleared.
description	string	Optional	A brief explanation of the object type.
labels	Model	Optional	Expand Create a new custom object schema — response body — labels
primaryDisplayProperty	string	Optional	The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
requiredProperties	array	Optional	The names of properties that should be **required** when creating an object of this type.
requiredProperties[]	string	Each item
restorable	boolean	Optional	Specifies if the object type can be restored after being deleted.
searchableProperties	array	Optional	Names of properties that will be indexed for this object type in by HubSpot's product search.
searchableProperties[]	string	Each item
secondaryDisplayProperties	array	Optional	The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
secondaryDisplayProperties[]	string	Each item

Referenced models: Create a new custom object schema — response body — labels

Create a new custom object schema — response body — labels

Field	Type	Presence	Description and constraints
$	object	Root
plural	string	Optional	The word for multiple objects. (There’s no way to change this later.)
singular	string	Optional	The word for one object. (There’s no way to change this later.)

Policy, approvals and errors

SDK function policy ID: hubspot.schemas_update_schema. Catalog operation: schemas_update_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: ["crm.schemas.custom.write"]

Official provider source