Skip to content

HubSpot: Create a contact

HubSpot contacts.createContact: arguments, response, policy and SDK examples.

← Contacts operations · Get started

Operation hubspot.contacts_create_contact

Provider route: POST /crm/objects/2026-09/contacts. 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["contacts"]["createContact"]>[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.contacts.createContact(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.contacts.create_contact(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Create a contact — request body — body

Referenced models: Create a contact — 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 contact — response body

Referenced models: Create a contact — response body

Create a contact — 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 CRM object to other objects. Each association specifies the target object and the type of association.
associations[]ModelEach itemExpand Create a contact — request body — body associations item
propertiesobjectRequired within parentAn object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the value is the property's value.
Additional keys: see wildcard field
properties.*stringAdditional keys

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

Create a contact — response body
FieldTypePresenceDescription and constraints
$objectRootA simple public object.
archivedbooleanRequired within parentA boolean indicating whether this 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 related to 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, each represented as an array of ValueWithTimestamp objects.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Create a contact — 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 this object.
warningsarrayOptionalAn array of PublicObjectWarning objects, each containing warnings related to this object.
warnings[]ModelEach itemExpand Create a contact — response body — warnings item

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

Create a contact — 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 Read batch objects — carts batch Get Carts — request body — body inputs item
typesarrayRequired within parentAn array of association specifications, each detailing the category and type of association between the objects.
types[]ModelEach itemExpand Create a contact — request body — body associations item types item

Referenced models: Read batch objects — carts batch Get Carts — request body — body inputs item, Create a contact — request body — body associations item types item

Create a contact — 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 representing the category of the warning.
contextobjectRequired within parentAn object providing additional context for the warning, with string values for each context key.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.
Create a contact — response body — properties With History value item
FieldTypePresenceDescription and constraints
$objectRootProperty model that includes timestamp.
sourceIdstringOptionalA string identifier for the specific source of the value.
sourceLabelstringOptionalA string label that provides a human-readable name for the source.
sourceTypestringRequired within parentA string indicating the type of source from which the value originated.
timestampstringRequired within parentThe date and time when the value was recorded, in ISO 8601 format.
Format: date-time
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeAn integer representing the ID of the user who last updated the value.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valuestringRequired within parentThe actual value being recorded. It is a string.
Read batch objects — carts batch Get Carts — request body — body inputs item
FieldTypePresenceDescription and constraints
$objectRootContains the Id of a Public Object
idstringRequired within parentA string representing the unique identifier for the object.
Create a contact — 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 parentThe category of the association, indicating its origin or purpose. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'.
One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeIdintegerRequired within parentAn integer representing the unique identifier for the type of association.
Format: int32

SDK function policy ID: hubspot.contacts_create_contact. Catalog operation: contacts_create_contact. 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.contacts.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.