Skip to main content
PATCH
Update product

Authorizations

Authorization
string
header
required

Enter your API key. Example: Bearer poelis_api_...

Path Parameters

product_id
string
required

Body

application/json

Request to update a product.

name
string | null

Product name

Minimum string length: 1
description
string | null

Product description

part_number
string | null

Assign a part number when the product has none, or pass null to remove (retire) the current one. In-place changes are not supported.

readable_id
string | null

Human-readable product ID (must be unique within workspace). Only lowercase letters, numbers and underscores are allowed.

Minimum string length: 1
Pattern: ^[a-z0-9_]+$
baseline_version_number
integer | null

Baseline version number (must be an existing product version)

Required range: x >= 1

Response

Updated product

Public representation of a product.

id
string
required
readable_id
string
required

Human-readable product ID

workspace_id
string
required

Workspace this product belongs to

name
string
required

Product name

description
string | null

Product description

part_number
string | null

Active product part number, when assigned. Uniqueness is enforced organization-wide; format is validated when the product has rule configuration in the app.

baseline_version_number
integer | null

User-selected baseline product version number.

archived
boolean
default:false

Whether the product is archived or not.

status
PublicProductStatus · object | null

Current workflow status for this product. Null when no status is set.

excludedStatusIds
string[]

Workspace-level status IDs that are hidden for this product.

owner
PublicUser · object | null

Product owner. Null when not set.

Example:
createdBy
PublicUser · object | null

User who created the product.

Example:
createdAt
string | null

ISO 8601 creation timestamp

updatedAt
string | null

ISO 8601 last-update timestamp

updatedBy
PublicUser · object | null

User who last updated the product

Example: