---
title: "Update Product by ID"
method: PATCH
path: "/v1/products/{productId}"
tags: ["Products"]
---

# Update Product by ID

`PATCH /v1/products/{productId}`

## Request

- Base URL: `https://api.jasper.ai`
- URL: `https://api.jasper.ai/v1/products/{productId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2
    - Authorization code: `https://api.jasper.ai/oauth2/authorize`
    - Token URL: `https://api.jasper.ai/oauth2/token` scopes: `user`

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 parameters

- `productId` string, required

## Request body

- UpdateProductRequestDto
  - `accessLevel` 'PRIVATE' | 'PUBLIC': Update who can access the product.
  - `attributes` ProductAttributeValueInput[]: 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).
    - `id` string, required: The attribute ID (from `GET /products/attributes`).
    - `value` union, required: The value to set. Its shape is inferred from the attribute's type: string (text), number, boolean, ISO-8601 date string, an option label — or an array of them — (enum / multi-select), an object (key-value), or an array of values for a list-mode attribute. To set categories, use the `Categories` attribute with an array of category names. For a `CONTEXT_SOURCE_LIST` attribute (such as the universal `Images`), send an array of source IDs — `["csc_…"]` — returned by `POST /v1/context-sources`. This is the same shape a read returns, so the value from a `GET` can be sent back as-is. The array replaces the whole set, so include the sources you want to keep and omit the ones to remove; send `[]` to remove all. Array order is preserved. Only `FILE` sources (uploaded files) can be attached, and the attribute may narrow that further — `Images` takes PNG and JPEG.
      - string
      - number
      - boolean
      - string[]
      - object
      - object[]

## Response `200`

Product updated

- ProductSingleResponseDto
  - `requestId` string, required
  - `resource` string, required
  - `data` ProductData, required
    - `id` string, required: The unique product ID (`prd_`, or legacy `itm_`).
    - `processingState` 'inProgress' | 'complete' | 'error', required: Processing state of the product.
    - `accessLevel` 'PRIVATE' | 'PUBLIC', required: Who can access the product.
    - `contextSourceIds` string[], required: The IDs of the sources the product itself was generated from, which are managed in the web app and not settable via this API. Empty when none are attached. Expand one with `GET /v1/context-sources/{sourceId}`. This is separate from the sources held by a `CONTEXT_SOURCE_LIST` attribute such as `Images`, which appear under `attributes` and can be set through this API.
    - `attributes` ProductAttributeValueData[], required: The product's attribute values, including the product name (the `Name` attribute). Categories are included here as the `Categories` attribute (an array of category names).
      - `id` string, required: The attribute ID.
      - `name` string, required: The attribute name.
      - `type` 'TEXT_SHORT' | 'TEXT_LONG' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'ENUM' | 'KEY_VALUE' | 'JSON' | 'CONTEXT_SOURCE_LIST', nullable: The attribute's normalized core type (matches the `type` from `GET /products/attributes`), or null when unresolved. List-mode attributes report their core type here and return an array `value`.
      - `isList` boolean, required: Whether the attribute holds a list of values (matches `GET /products/attributes`). When true, `value` is an array.
      - `value` union: The attribute value, typed to match `type`: a string (`TEXT_SHORT`/`TEXT_LONG`/`DATE`, and the option label for `ENUM`), a number (`NUMBER`), a boolean (`BOOLEAN`), an object (`KEY_VALUE`/`JSON`), an array of source IDs (`CONTEXT_SOURCE_LIST`, e.g. `Images` — expand one with `GET /v1/context-sources/{sourceId}`), or — for list-mode attributes — an array of the above (e.g. option labels for a multi-select). Null when the attribute is unset.
        - string
        - number
        - boolean
        - string[]
        - object
        - object[]
    - `createdAt` string, required
    - `updatedAt` string, required

## Other 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.

## Changes

- **2026-11-03** `3d5be7408661`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/jasper/apis/jasper-api/changes/v1/products/:productId/patch.md)

---

[API](https://skmtc.dev/jasper/apis/jasper-api.md) - [All operations](https://skmtc.dev/jasper/apis/jasper-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jasper/apis/jasper-api/revisions/3d5be7408661?raw)