HighLevel: Update Product by ID

← Products operations · Get started

Operation gohighlevel.update_product_by_id

Provider route: PUT /products/{productId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["products"]["updateProductById"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.products.updateProductById(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.products.update_product_by_id(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.productId	string	Required within parent
body	Model	Required within parent	Expand Update Product by ID — request body — body

Referenced models: Update Product by ID — 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 Product — response body

Referenced models: Create Product — response body

Schemas

Create Product — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the product.
automaticTaxCategoryId	string	Optional	Tax category ID for Automatic taxes calculation.
availableInStore	boolean	Optional	Indicates whether the product is available in-store.
collectionIds	array	Optional	An array of category Ids for the product
collectionIds[]	string	Each item
createdAt	string	Required within parent	The creation timestamp of the product. Format: date-time
description	string	Optional	product description
image	string	Optional	The URL for the product image.
isTaxesEnabled	boolean	Optional	The field indicates whether taxes are enabled for the product or not. Default: false
label	JSON	Optional	The Product label details
label (allOf 1)	Model	All variants apply	Expand Create Product — response body — label end Date, start Date, title
locationId	string	Required within parent	The unique identifier for the location.
name	string	Required within parent	The name of the product.
productType	string	Required within parent	The type of the product (e.g., PHYSICAL).
slug	string	Optional	The slug of the product by which the product will be navigated
statementDescriptor	string	Optional	The statement descriptor for the product.
taxes	array	Optional	An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.
taxes[]	string	Each item
updatedAt	string	Required within parent	The last update timestamp of the product. Format: date-time
variants	array	Optional	An array of variants for the product.
variants[]	Model	Each item	Expand Create Product — response body — variants item

Referenced models: Create Product — response body — label end Date, start Date, title, Create Product — response body — variants item

Update Product by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
automaticTaxCategoryId	string	Optional	Tax category ID for Automatic taxes calculation.
availableInStore	boolean	Optional	Indicates whether the product is available in-store.
collectionIds	array	Optional	An array of category Ids for the product
collectionIds[]	string	Each item
description	string	Optional	A brief description of the product.
image	string	Optional	The URL for the product image.
isLabelEnabled	boolean	Optional	Is the product label enabled. If this is true, label object cannot be empty. Default: false
isTaxesEnabled	boolean	Optional	Are there any taxes attached to the product. If this is true, taxes array cannot be empty. Default: false
label	JSON	Optional	Details for Product Label
label (allOf 1)	Model	All variants apply	Expand Create Product — response body — label end Date, start Date, title
locationId	string	Required within parent	The unique identifier for the location.
medias	array	Optional	An array of medias for the product.
medias[]	Model	Each item	Expand Create Product — request body — body medias item
name	string	Required within parent	The name of the product.
prices	array	Optional	The prices of the product
prices[]	string	Each item
productType	string	Required within parent	One of: DIGITAL, PHYSICAL, SERVICE, PHYSICAL/DIGITAL
seo	JSON	Optional	SEO data for the product that will be displayed in the preview
seo (allOf 1)	Model	All variants apply	Expand Create Product — request body — body seo description, title
slug	string	Optional	The slug using which the product navigation will be handled
statementDescriptor	string	Optional	The statement descriptor for the product.
taxInclusive	boolean	Optional	Whether the taxes should be included in the purchase price Default: false
taxes	array	Optional	List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
taxes[]	string	Each item
variants	array	Optional	An array of variants for the product.
variants[]	Model	Each item	Expand Create Product — response body — variants item

Referenced models: Create Product — response body — label end Date, start Date, title, Create Product — response body — variants item, Create Product — request body — body medias item, Create Product — request body — body seo description, title

Create Product — response body — label end Date, start Date, title

Field	Type	Presence	Description and constraints
$	object	Root
endDate	string	Optional	Start date in YYYY-MM-DDTHH:mm:ssZ format
startDate	string	Optional	Start date in YYYY-MM-DDTHH:mm:ssZ format
title	string	Required within parent	The content for the product label.

Create Product — response body — variants item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	A unique identifier for the variant.
name	string	Required within parent	The name of the variant.
options	array	Required within parent	An array of options for the variant.
options[]	Model	Each item	Expand Create Product — response body — variants item options item

Referenced models: Create Product — response body — variants item options item

Create Product — request body — body medias item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the media.
isFeatured	boolean	Optional	Indicates whether the media is featured.
priceIds	array	Optional	Mongo ObjectIds of the prices for which the media is assigned
priceIds[]	array	Each item
title	string	Optional	The title of the media file.
type	string	Required within parent	The type of the media file (e.g., image, video will be supporting soon). One of: image, video
url	string	Required within parent	The URL where the media file is stored.

Create Product — request body — body seo description, title

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	SEO description
title	string	Optional	SEO title

Create Product — response body — variants item options item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the option.
name	string	Required within parent	The name of the option.

Policy, approvals and errors

SDK function policy ID: gohighlevel.update_product_by_id. Catalog operation: update-product-by-id. 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: ["products.write"]

Pinned headers: {"Version": "v3"}

Official provider source