Products

Update Product by ID

Changed on

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.

patch/v1/products/{productId}

Request

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

Path parameters

productIdstring required
Example:prd_073D2D49094A4AED991A47B614522579

The Product's unique ID (prd_, or legacy itm_). Both are accepted.

Request body

accessLevel'PRIVATE' | 'PUBLIC'

Update who can access the product.

Example request

{
  "attributes": [
    {
      "id": "atr_535B1EC15F5F41EAB1B400E9ED4077B6"
    }
  ]
}

Response

Product updated

requestIdstring required
resourcestring required

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "products",
  "data": {
    "id": "prd_073D2D49094A4AED991A47B614522579",
    "processingState": "complete",
    "accessLevel": "PRIVATE",
    "contextSourceIds": [
      "csc_073D2D49094A4AED991A47B614522579"
    ],
    "attributes": [
      {
        "id": "atr_535B1EC15F5F41EAB1B400E9ED4077B6",
        "name": "Overview",
        "type": "TEXT_LONG"
      }
    ],
    "createdAt": "2026-06-30T15:38:00.474Z",
    "updatedAt": "2026-06-30T15:38:00.474Z"
  }
}

Changes