HubSpot: Update tag (Partial)

← Object tags operations · Get started

Operation hubspot.object_tags_partially_update_object_tag

Provider route: PATCH /crm/object-tags/2026-09/{objectTypeId}/{tagId}. 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["objectTags"]["partiallyUpdateObjectTag"]>[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.objectTags.partiallyUpdateObjectTag(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.object_tags.partially_update_object_tag(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.objectTypeId	string	Required within parent
path.tagId	integer	Required within parent	Format: int64
body	Model	Required within parent	Expand Update tag (Partial) — request body — body

Referenced models: Update tag (Partial) — 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 tag — response body

Referenced models: Create tag — response body

Schemas

62 more schemas are linked from the tables above, on the schema pages.

Create tag — response body

Field	Type	Presence	Description and constraints
$	object	Root
color	string	Required within parent	The color associated with the CRM object tag, represented as a string.
createdAt	string	Required within parent	The date and time when the tag was created, in ISO 8601 format. Format: date-time
createdBy	JSON	Optional
createdBy (anyOf 1)	integer	Alternative	An integer representing the ID of the user who created the tag. Format: int64
createdBy (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	A string providing a description of the CRM object tag.
displayOrder	JSON	Required within parent
displayOrder (anyOf 1)	integer	Alternative	An integer indicating the display order of the tag. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
filterBranch	JSON	Required within parent	A complex object defining the filter branch associated with the tag, which can include various filter types and branches.
filterBranch (anyOf 1)	Model	Alternative	Expand Create tag — response body — filterBranch / filterBranchType: OR
filterBranch (anyOf 2)	Model	Alternative	Expand Create tag — response body — filterBranch / filterBranchType: AND
filterBranch (anyOf 3)	Model	Alternative	Expand Create tag — response body — filterBranch / filterBranchType: NOT ALL
filterBranch (anyOf 4)	Model	Alternative	Expand Create tag — response body — filterBranch / filterBranchType: NOT ANY
filterBranch (anyOf 5)	Model	Alternative	Expand Create tag — response body — filterBranch / filterBranchType: RESTRICTED
filterBranch (anyOf 6)	Model	Alternative	Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranch (anyOf 7)	Model	Alternative	Expand Create tag — response body — filterBranch / filterBranchType: ASSOCIATION
filterPipelineIds	array	Required within parent	An array of strings representing the pipeline IDs that this tag is associated with.
filterPipelineIds[]	string	Each item
id	string	Required within parent	The unique identifier for the CRM object tag, represented as a string.
lastModifiedBy	JSON	Optional
lastModifiedBy (anyOf 1)	integer	Alternative	An integer representing the ID of the user who last modified the tag. Format: int64
lastModifiedBy (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the CRM object tag, represented as a string.
objectTypeId	string	Required within parent	The identifier for the type of object this tag is associated with, represented as a string.
updatedAt	string	Required within parent	The date and time when the tag was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED

Update tag (Partial) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
color	object	Required within parent	An object representing the new color for the CRM object tag.
description	object	Required within parent	An object representing the new description for the CRM object tag.
filterBranch	object	Required within parent	An object representing the new filter branch for the CRM object tag.
filterPipelineIds	object	Required within parent	An object representing the new set of pipeline IDs associated with the CRM object tag.
name	object	Required within parent	An object representing the new name for the CRM object tag.

Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH

Field	Type	Presence	Description and constraints
$	object	Root
adNetwork	string	Required within parent	A string that specifies the ad network where the search is being conducted.
entityType	string	Required within parent	A string that represents the type of entity being searched for in the ads.
filterType	string	Required within parent	A string that specifies the type of filter being applied. The default value is 'ADS_SEARCH'. Known values: ADS_SEARCH Default: ADS_SEARCH
operator	string	Required within parent	A string that defines the operation or condition applied to the search terms.
searchTermType	string	Required within parent	A string that indicates the type of search term being used in the filter.
searchTerms	array	Required within parent	An array of strings containing the search terms used to filter the ads.
searchTerms[]	string	Each item

Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION

Field	Type	Presence	Description and constraints
$	object	Root
acceptedOptStates	array	Required within parent	An array of strings representing the opt-in states that are accepted for the filter.
acceptedOptStates[]	string	Each item
businessUnitId	string	Optional	A string representing the ID of the business unit associated with the subscription.
channel	string	Required within parent	A string indicating the communication channel associated with the subscription.
filterType	string	Required within parent	A string that specifies the type of filter. Default value is 'COMMUNICATION_SUBSCRIPTION'. Known values: COMMUNICATION_SUBSCRIPTION Default: COMMUNICATION_SUBSCRIPTION
subscriptionIds	array	Required within parent	An array of strings representing the IDs of the subscriptions to be filtered.
subscriptionIds[]	string	Each item
subscriptionType	string	Required within parent	A string indicating the type of subscription being filtered.

Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Field	Type	Presence	Description and constraints
$	object	Root
filterType	string	Required within parent	A string representing the type of filter. The default value is 'CONSTANT'. Known values: CONSTANT Default: CONSTANT
shouldAccept	boolean	Required within parent	A boolean indicating whether the filter should accept the criteria. If true, the criteria are accepted; if false, they are rejected.
source	string	Optional	A string providing the source of the filter. This property is optional.

Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION

Field	Type	Presence	Description and constraints
$	object	Root
acceptedStatuses	array	Required within parent	An array of strings indicating the subscription statuses that are accepted in the filter.
acceptedStatuses[]	string	Each item
filterType	string	Required within parent	A string indicating the type of filter, which is 'EMAIL_SUBSCRIPTION' for this component. Known values: EMAIL_SUBSCRIPTION Default: EMAIL_SUBSCRIPTION
subscriptionIds	array	Required within parent	An array of strings representing the IDs of the subscriptions to be filtered.
subscriptionIds[]	string	Each item
subscriptionType	string	Optional	A string representing the type of subscription, which may be used to further refine the filter.

Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST

Field	Type	Presence	Description and constraints
$	object	Root
filterType	string	Required within parent	A string that specifies the type of filter. The default value is 'IN_LIST'. Known values: IN_LIST Default: IN_LIST
listId	string	Required within parent	A string representing the unique identifier of the list to filter against.
metadata	Model	Optional	Expand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata
operator	string	Required within parent	A string representing the operator used in the filter.

Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string that specifies the type of refinement. The default and only valid value is 'ALL_HISTORY'. Known values: ALL_HISTORY Default: ALL_HISTORY

Policy, approvals and errors

SDK function policy ID: hubspot.object_tags_partially_update_object_tag. Catalog operation: object_tags_partially_update_object_tag. 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-pipelines-object-label-access"]

Official provider source