Skip to content

HubSpot: Update — line Items update Line Item

HubSpot lineItems.updateLineItem: arguments, response, policy and SDK examples.

← Line items operations · Get started

Operation hubspot.line_items_update_line_item

Provider route: PATCH /crm/objects/2026-09/line_items/{lineItemId}. 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["lineItems"]["updateLineItem"]>[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.lineItems.updateLineItem(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.line_items.update_line_item(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.lineItemIdstringRequired within parentPattern: .+
queryobjectOptionalAdditional keys: not allowed
query.idPropertystringOptional
bodyModelRequired within parentExpand Update — line Items update Line Item — request body — body

Referenced models: Update — line Items update Line Item — 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 Merge objects — line Items merge — response body

Referenced models: Merge objects — line Items merge — response body

Update — line Items update Line Item — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents the input required to update a CRM object, containing an object with property names and their corresponding values.
propertiesobjectRequired within parentAn object containing key-value pairs where keys are property names and values are the new property values. Each property value is a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
Merge objects — line Items merge — 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 used for tracing the 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 arrays of historical values, each represented by a 'ValueWithTimestamp' object.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — line Items get Line Item — 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
urlstringOptionalThe URL associated with this object, represented as a string.
warningsarrayOptionalAn array of warnings related to this object, each represented by a 'PublicObjectWarning' object.
warnings[]ModelEach itemExpand Read — line Items get Line Item — response body — warnings item

Referenced models: Read — line Items get Line Item — response body — warnings item, Read — line Items get Line Item — response body — properties With History value item

Read — line Items get Line Item — 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 that describes the issue or consideration.
Read — line Items get Line Item — response body — properties With History value item
FieldTypePresenceDescription and constraints
$objectRootProperty model that includes timestamp.
sourceIdstringOptionalA string representing the unique identifier of the source.
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 was derived.
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 of the property at the given timestamp. It is a string.

SDK function policy ID: hubspot.line_items_update_line_item. Catalog operation: line_items_update_line_item. 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.line_items.write", "e-commerce"]

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.