HighLevel: Update Product Collection

← Products operations · Get started

Operation gohighlevel.update_product_collection

Provider route: PUT /products/collections/{collectionId}. 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"]["updateProductCollection"]>[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.updateProductCollection(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_collection(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.collectionId	string	Required within parent
body	Model	Required within parent	Expand Update Product Collection — request body — body

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

Referenced models: Update Inventory — response body

Schemas

Update Inventory — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	Success message
status	boolean	Required within parent	Status of api action

Update Product Collection — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	The type of alt. For now it is only LOCATION One of: location
image	string	Optional	The URL of the image that is going to be displayed as the collection Thumbnail
name	string	Optional	Name of the Product Collection
seo	JSON	Optional	The metadata information which will be displayed in SEO previews
seo (allOf 1)	Model	All variants apply	Expand Create Product Collection — request body — body seo description, title
slug	string	Optional	Slug of the Product Collection which helps in navigation

Referenced models: Create Product Collection — request body — body seo description, title

Create Product Collection — request body — body seo description, title

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	The description which would be displayed in preview purposes
title	string	Optional	The title which will be displayed as an SEO format

Policy, approvals and errors

SDK function policy ID: gohighlevel.update_product_collection. Catalog operation: update-product-collection. 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/collection.write"]

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

Official provider source