Skip to content

HubSpot: Update — partner Clients update Partner Client

HubSpot partnerClients.updatePartnerClient: arguments, response, policy and SDK examples.

← Partner clients operations · Get started

Operation hubspot.partner_clients_update_partner_client

Provider route: PATCH /crm/objects/2026-09/partner_clients/{partnerClientId}. 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["partnerClients"]["updatePartnerClient"]>[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.partnerClients.updatePartnerClient(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.partner_clients.update_partner_client(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.partnerClientIdstringRequired within parentPattern: .+
queryobjectOptionalAdditional keys: not allowed
query.idPropertystringOptional
bodyModelRequired within parentExpand Update — partner Clients update Partner Client — request body — body

Referenced models: Update — partner Clients update Partner Client — 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 — partner Clients create — response body

Referenced models: Create — partner Clients create — response body

Create — partner Clients create — 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 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 its timestamp.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Create — partner Clients create — 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 associated with this object.
warningsarrayOptionalAn array of warnings related to this object, where each warning includes a category, message, and context.
warnings[]ModelEach itemExpand Read — projects get Project — response body — warnings item

Referenced models: Read — projects get Project — response body — warnings item, Create — partner Clients create — response body — properties With History value item

Update — partner Clients update Partner Client — 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 each key is the name of a property and the value is the property's value. Each property is represented as a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
Read — projects get Project — 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 about the warning, with string properties.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.
Create — partner Clients create — 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 providing additional context about 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 parentA string representing the value associated with the timestamp.

SDK function policy ID: hubspot.partner_clients_update_partner_client. Catalog operation: partner_clients_update_partner_client. 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.partner-clients.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.