Skip to content

HubSpot: Create a company

HubSpot companies.createCompany: arguments, response, policy and SDK examples.

← Companies operations · Get started

Operation hubspot.companies_create_company

Provider route: POST /crm/objects/2026-09/companies. Alter supplies the connection’s credentials and routing.

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["companies"]["createCompany"]>[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.companies.createCompany(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.companies.create_company(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Create a company — request body — body

Referenced models: Create a company — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a company — response body

Referenced models: Create a company — response body

Create a company — request body — body
FieldTypePresenceDescription and constraints
$objectRootIs the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associationsarrayRequired within parentAn array of associations that link this object to other objects. Each association specifies the target object and the type of association.
associations[]ModelEach itemExpand Create a company — request body — body associations item
propertiesobjectRequired within parentThe company property values to set.
Additional keys: see wildcard field
properties.*stringAdditional keys

Referenced models: Create a company — request body — body associations item

Create a company — response body
FieldTypePresenceDescription and constraints
$objectRootA simple public object.
archivedbooleanRequired within parentA boolean indicating whether the object is archived.
archivedAtstringOptionalThe date and time when this object was archived, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe date and time when this object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique identifier for this object, represented as a string.
objectWriteTraceIdstringOptionalA string representing the trace ID for write operations on this object.
propertiesobjectRequired within parentA map of property names to their values, where each value is a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalA map of property names to their historical values, where each value is an array of objects containing the value and timestamp.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Create a company — response body — properties With History value item
updatedAtstringRequired within parentThe date and time when this object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalA string containing the URL of the object.
warningsarrayOptionalAn array of warning objects, each containing details about potential issues with the object.
warnings[]ModelEach itemExpand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Create a company — response body — properties With History value item

Create a company — request body — body associations item
FieldTypePresenceDescription and constraints
$objectRootRepresents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
toModelRequired within parentExpand Create a company — request body — body associations item to
typesarrayRequired within parentAn array of association specifications, each detailing the type of association between the objects.
types[]ModelEach itemExpand Create a company — request body — body associations item types item

Referenced models: Create a company — request body — body associations item types item, Create a company — request body — body associations item to

Create a company — response body — warnings item
FieldTypePresenceDescription and constraints
$objectRootRepresents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
categorystringRequired within parentA string indicating the category of the warning.
contextobjectRequired within parentAn object providing additional context about the warning, with string properties.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.
Create a company — response body — properties With History value item
FieldTypePresenceDescription and constraints
$objectRootProperty model that includes timestamp.
sourceIdstringOptionalThe identifier of the source from which the value was obtained. It is a string.
sourceLabelstringOptionalA label providing additional context about the source. It is a string.
sourceTypestringRequired within parentThe type of source from which the value was obtained. It is a string and is required.
timestampstringRequired within parentThe date and time when the value was recorded, in ISO 8601 format.
Format: date-time
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeThe ID of the user who last updated the value. It is an integer.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valuestringRequired within parentThe value associated with the timestamp. It is a string.
Create a company — request body — body associations item types item
FieldTypePresenceDescription and constraints
$objectRootDefines the type, direction, and details of the relationship between two CRM objects.
associationCategorystringRequired within parentFor [labeled associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#associate-records-with-a-label), the category of the association.
One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeIdintegerRequired within parentThe [association type ID](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#association-type-id-values) (e.g., `4` for contact-to-company associations).
Format: int32
Create a company — request body — body associations item to
FieldTypePresenceDescription and constraints
$objectRootContains the Id of a Public Object
idstringRequired within parentThe ID of the target record to associate.

SDK function policy ID: hubspot.companies_create_company. Catalog operation: companies_create_company. 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.objects.companies.write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.