HubSpot: Create — leads create Lead

← Leads operations · Get started

Operation hubspot.leads_create_lead

Provider route: POST /crm/objects/2026-09/leads. 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["leads"]["createLead"]>[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.leads.createLead(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.leads.create_lead(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 — leads create Lead — request body — body

Referenced models: Create — leads create Lead — 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 — leads create Lead — response body

Referenced models: Create — leads create Lead — response body

Schemas

Create — leads create Lead — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Is 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.
associations	array	Required within parent	An array of associations that link this object to other objects. Each association is defined by the 'PublicAssociationsForObject' schema.
associations[]	Model	Each item	Expand Create — leads create Lead — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM object. Each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — leads create Lead — request body — body associations item

Create — leads create Lead — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string representing the trace ID for write operations on this object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each containing a value and a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — leads get Lead — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string containing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — leads get Lead — response body — warnings item

Referenced models: Read — leads get Lead — response body — warnings item, Read — leads get Lead — response body — properties With History value item

Create — leads create Lead — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
to	Model	Required within parent	Expand Create — leads create Lead — request body — body associations item to
types	array	Required within parent	An array of association specifications, detailing the types of associations that exist between the objects. Each item in the array is an AssociationSpec object.
types[]	Model	Each item	Expand Create — carts create Cart — request body — body associations item types item

Referenced models: Create — carts create Cart — request body — body associations item types item, Create — leads create Lead — request body — body associations item to

Read — leads get Lead — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string indicating the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the message that describes the warning.

Read — leads get Lead — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string identifier for the specific source of the value.
sourceLabel	string	Optional	A string label providing a human-readable description of the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value was derived. This property is required.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the value, represented as an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The value associated with the timestamp. It is represented as a string.

Create — carts create Cart — request body — body associations item types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	The category of the association, which can be one of 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer representing the unique identifier for the type of association. Format: int32

Create — leads create Lead — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	A string representing the unique identifier for the public object.

Policy, approvals and errors

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

Official provider source