Update Product by ID

Update a Product in your workspace. Only the attributes you include are changed, so omit an attribute to leave it alone. Note that a CONTEXT_SOURCE_LIST attribute such as Images is replaced wholesale by the value you send: include the sources you want to keep, and send [] to remove all of them.

Path Params
string
required

The Product's unique ID

Body Params
string
enum

Update who can access the product.

Allowed:
attributes
array of objects

Attribute values to set or replace. Omit an attribute to leave it unchanged — that is how you update one attribute without disturbing the others. Categories are updated here too, via the Categories attribute (an array of category names; pass an empty array to clear all categories). Categories must already exist in the schema editor; unknown names are rejected. Images are updated via the Images attribute, whose value is the full set of sources to keep (see value below).

attributes
Responses

400

Bad request. May be missing required inputs or may have badly formatted inputs.

401

Unauthorized access to the workspace.

403

Product IQ is not enabled for this workspace.

404

Not found. The product does not exist in your workspace.

500

Internal server error. Unable to update product.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json