HubSpot: Update — deals update Deal

← Deals operations · Get started

Operation hubspot.deals_update_deal

Provider route: PATCH /crm/objects/2026-09/0-3/{dealId}. 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["deals"]["updateDeal"]>[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.deals.updateDeal(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.deals.update_deal(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.dealId	string	Required within parent	Pattern: .+
query	object	Optional	Additional keys: not allowed
query.idProperty	string	Optional
body	Model	Required within parent	Expand Update — deals update Deal — request body — body

Referenced models: Update — deals update Deal — 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 — deals create Deal — response body

Referenced models: Create — deals create Deal — response body

Schemas

Update — deals update Deal — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
properties	object	Required within parent	Key value pairs representing the properties of the object. Additional keys: see wildcard field
properties.*	string	Additional keys

Create — deals create Deal — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	Whether the object is archived.
archivedAt	string	Optional	The timestamp when the object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The timestamp when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique ID of the object.
objectWriteTraceId	string	Optional	An identifier used for tracing the creation or update request of the object.
properties	object	Required within parent	Key-value pairs representing the properties of the object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	Key-value pairs representing the properties of the object along with their history. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — deals get Deal — response body — properties With History value item
updatedAt	string	Required within parent	The timestamp when the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL for 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 — deals get Deal — response body — warnings item

Referenced models: Read — deals get Deal — response body — warnings item, Read — deals get Deal — response body — properties With History value item

Read — deals get Deal — 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 representing the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with keys and values as strings. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Read — deals get Deal — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	The unique ID of the property.
sourceLabel	string	Optional	A human-readable label.
sourceType	string	Required within parent	The property type.
timestamp	string	Required within parent	The timestamp when the property was updated, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the property. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The property value.

Policy, approvals and errors

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

Official provider source