---
title: "patchProduct"
method: PATCH
path: "/v1/product/{productId}"
tags: ["Product"]
---

# patchProduct

`PATCH /v1/product/{productId}`

Partially update a specific product entity's properties by a given id and a given payload

## Path parameters

- `productId` string, uuid, required

## Request body

- ProductPatch
  - `_schema` 'product'
  - `active` boolean
  - `price_options` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `product_images` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `product_downloads` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_availability_files` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `name` string — The description for the product
  - `categories` string[] — The categories of the product
  - `internal_name` string — Not visible to customers, only in internal tables
  - `code` string — The product code
  - `type` 'product' | 'service' — The type of Product: | type | description | |----| ----| | `product` | Represents a physical good | | `service` | Represents a service or virtual product |
  - `description` string — A description of the product. Multi-line supported.
  - `feature` unknown[]
    - unknown
  - `_tags` string[], nullable
  - `_purpose` string[], nullable
  - `_files` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_manifest` string[] — Manifest ID used to create/update the entity
  - `__additional` object, nullable — Additional fields that are not part of the schema

## Response `200`

Product entity response

- Product
  - `_id` string, uuid
  - `_schema` 'product', required
  - `_org` string, required — Organization Id the entity belongs to
  - `_tags` string[], nullable
  - `_files` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_owners` BaseEntityOwner[]
    - `org_id` string, required
    - `user_id` string
  - `_title` string
  - `_created_at` string, date-time
  - `_updated_at` string, date-time
  - `_acl` BaseEntityAcl — Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
    - `view` string[]
    - `edit` string[]
    - `delete` string[]
  - `active` boolean, required
  - `price_options` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `product_images` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `product_downloads` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_availability_files` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `name` string, required — The description for the product
  - `categories` string[] — The categories of the product
  - `internal_name` string — Not visible to customers, only in internal tables
  - `code` string — The product code
  - `type` 'product' | 'service', required — The type of Product: | type | description | |----| ----| | `product` | Represents a physical good | | `service` | Represents a service or virtual product |
  - `description` string — A description of the product. Multi-line supported.
  - `feature` unknown[]
    - unknown
  - `_purpose` string[], nullable
  - `_manifest` string[] — Manifest ID used to create/update the entity
  - `__additional` object, nullable — Additional fields that are not part of the schema

## Other responses

- `400` — Any error based on client data errors
- `500` — Any error based on the server-side

---

[API](https://skmtc.dev/epilot/apis/product-api.md) · [All operations](https://skmtc.dev/epilot/apis/product-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/epilot/product-api/revisions/246cfb2edf7f/schema)